Python 文档生成器
项目描述
Sphinx 是一个工具，可以轻松地为 Python 项目（或由多个 reStructuredText 源组成的其他文档）创建智能且美观的文档，由 Georg Brandl 编写。它最初是为新的 Python 文档创建的，并且为 Python 项目文档提供了出色的工具，但也支持 C/C++，并且计划使用更多语言。
Sphinx 使用 reStructuredText 作为其标记语言，它的许多优势来自 reStructuredText 及其解析和翻译套件 Docutils 的强大和直接性。
其特点如下：
输出格式：HTML（包括衍生格式，如 HTML 帮助、Epub 和 Qt 帮助）、纯文本、手册页和 LaTeX 或使用 rst2pdf 的直接 PDF 输出
广泛的交叉引用：语义标记和函数、类、词汇表术语和类似信息的自动链接
层次结构：文档树的简单定义，自动链接到兄弟姐妹、父母和孩子
自动索引：通用索引以及模块索引
代码处理：使用 Pygments 荧光笔自动高亮显示
使用 Jinja 2 模板引擎灵活的 HTML 输出
可以使用各种扩展，例如用于片段的自动测试和包含适当格式的文档字符串
设置工具集成
有关详细信息，请参阅文档。
安装
Sphinx 发布在PyPI上，可以从那里安装：
pip install -U sphinx
我们还发布测试版：
pip install -U --pre sphinx
如果您希望安装Sphinx用于开发目的，请参阅贡献者指南。
文档
文档可从sphinx-doc.org 获得。
保持联系
在 GitHub 上报告错误、建议功能或查看源代码。
对于不太明确的问题或想法，请使用邮件列表。
请遵守我们的行为准则。
测试
Travis（用于 Linux 上的单元测试和样式检查）、AppVeyor（用于 Windows 上的单元测试）和CircleCI（用于像 TeX 编译这样的大型进程）提供了持续测试。
有关在本地运行测试的信息，请参阅贡献者指南。
贡献
请参阅贡献者指南。
发布签名
版本使用以下密钥签名：
