Sphinx

Sphinx 是 Python 生态系统中最流行的文档生成工具。它可以从代码注释和文档字符串自动生成美观的 HTML、PDF 等格式的文档。Sphinx 支持多种扩展，被广泛用于 Python 项目的官方文档生成，包括 Python 本身的官方文档。

1. 1
   确保安装了Python 3.8+，在终端输入python --version检查，创建虚拟环境：python -m venv docs_env && source docs_env/bin/activate
2. 2
   使用pip安装Sphinx及常用扩展：pip install sphinx sphinx-autobuild sphinx-rtd-theme myst-parser
3. 3
   在项目目录初始化Sphinx文档：sphinx-quickstart docs，按提示配置项目名称、作者、语言等信息
4. 4
   编辑docs/conf.py配置文件，设置主题为Read the Docs：html_theme = "sphinx_rtd_theme"，并配置扩展extensions = ["myst_parser", "sphinx.ext.autodoc"]
5. 5
   在docs/source目录编写rst或md格式文档，然后生成HTML文档：sphinx-build -b html docs/source docs/build，访问docs/build/index.html查看