Sphinx创建智能且美观的文档

Sphinx 是由 Georg Brandl 编写的工具，可轻松为 Python 项目（或由多个 reStructuredText 源组成的其他文档）创建智能且美观的文档。它最初是为新的 Python 文档创建的，具有用于Python项目文档的出色功能，但同时也支持C / C ++，并且计划了更多的语言。

Sphinx使用reStructuredText作为标记语言，它的许多优势来自reStructuredText及其解析和翻译套件Docutils的强大功能和直接性。

其功能包括：

• 输出格式：HTML（包括派生格式，例如HTML帮助，Epub和Qt帮助），纯文本，手册页和LaTeX或使用rst2pdf的直接PDF输出
• 广泛的交叉引用：功能，类，词汇术语和类似信息的语义标记和自动链接
• 层次结构：轻松定义文档树，并自动链接到兄弟姐妹，父母和孩子
• 自动索引：常规索引以及模块索引
• 代码处理：使用Pygments荧光笔自动突出显示
• 使用Jinja 2模板引擎灵活的HTML输出
• 提供各种扩展名，例如，用于自动测试代码片段和包含适当格式的文档字符串
• Setuptools 集成