用途:为 Python 库创建完整文档,包括 Google 风格 docstring、Sphinx 站点、API 参考、教程和 ReadTheDocs 配置。
主要能力:提供 Google 风格 docstring 写法(Args、Returns、Raises、Example 段落);Sphinx 快速搭建步骤;pyproject.toml 文档依赖配置;README 模板;ReadTheDocs 的 .readthedocs.yaml 配置;以及文档检查清单。
使用方式:安装文档依赖可用 uv add --dev sphinx furo myst-parser sphinx-copybutton,然后运行 sphinx-quickstart docs/ 初始化。conf.py 中启用 sphinx.ext.autodoc、sphinx.ext.napoleon(支持 Google docstring)和 myst_parser(Markdown 支持),主题设为 furo。文档依赖也可写入 pyproject.toml 的 [project.optional-dependencies] docs 中。ReadTheDocs 使用 version 2 配置,指定 docs/conf.py 并以 pip 方式安装当前项目及 docs 额外依赖。
适用场景:需要为开源或内部 Python 库建立可发布文档、API 参考与教程的开发者。
限制:资料未提供具体版本兼容性、构建失败排查、托管收费等细节;示例代码与配置需按实际项目调整。