Sphinx + GitHub + Read the Docs 的文档管理方法
https://blog.csdn.net/lu_embedded/article/details/109006380
ubuntu24.04安装步骤
sudo apt install python3-sphinx
新建
- sphinx-quickstart
- Project name: Sphinx例程
- Author name(s): mkj
- Author name(s): mkj
- make
make html- 预览
- build/html/index.html就是生成的文档
- sphinx-autobuild source build/html
- sudo apt install python3-sphinx-autobuild
- 默认启动 8000 端口，在浏览器输入 http://127.0.0.1:8000
vs插件
https://ebf-contribute-guide.readthedocs.io/zh-cn/latest/install-sphinx-env/vscode.html
https://marketplace.visualstudio.com/items?itemName=lextudio.restructuredtext
python、reStructuredText、RST Preview