mirror of
https://github.com/sipeed/sipeed_wiki.git
synced 2026-11-09 17:44:31 -06:00
55100ca7e5
- add pyproject.toml and uv.lock pinning teedoc 1.37.9 with the twelve plugins listed in site_config.json, plus setuptools: babel's babel.messages.frontend imports distutils, which is no longer part of the standard library on Python 3.12+ - declare Python >= 3.10, the floor required by the pinned setuptools - replace the pip preview steps in README.md and share_docs/zh/add_doc.md with "uv sync && uv run teedoc serve"; the plugins now come from the lockfile, so teedoc install is no longer needed
Sipeed wiki source docs
Sipeed official Wiki: wiki.sipeed.com
Contributing and article sharing
You are welcome to contribute to the wiki, fixing error, adding content, or sharing your article are all welcome.
Fork this repo and change docs, then create a Pull Request.
More contribute doc :
Preview locally
git clone https://github.com/sipeed/sipeed_wiki.git
cd sipeed_wiki
uv sync
uv run teedoc serve
uv sync creates/updates the .venv from pyproject.toml and uv.lock, which already includes teedoc and all plugins used by this site (so teedoc install is not needed).
Install uv first if you don't have it.
More build tool usage see teedoc
For administrator
GitHub action will automatically push changed doc to cloud server. But if you did some special things like force commit, some files maybe missing on server, manually trigger the publish_upload_all action to build doc and upload all files to server.