欢迎
Sphinx 是在 BSD 许可证下由 Georg Brandl 编写，用于创建智能而美丽文档的工具。
它最初是为 Python 文档 而创建，并且它有很好的设施来记录一系列语言的软件项目。当然，这个网站也是使用 Sphinx 从 reStructuredText 源创建的！应该强调以下特点：
- 输出格式：HTML（包括 Windows HTML 帮助）、LaTeX（用于可打印的 PDF 版本）、ePub、Texinfo、手册页、纯文本
- 广泛的交叉引用：语义标记和自动链接 函数、类、引文、术语表和类似的的信息片段
- 分层结构：轻松定义文档树，自动链接到同胞、父级和子级
- 自动索引：一般索引以及特定语言的模块索引
- 代码处理：自动高亮显示，使用 Pygments 高亮
- 插件：自动测试代码片段，纳入 Python 模块的文档字符串（API 文档），以及 更多内容
- 贡献的插件： 几十个插件 由用户贡献的；其中大部分可从 PyPI 安装
Sphinx 使用 reStructuredText 作为其标记语言，它的许多优势来自 reStructuredText 及其解析和翻译套件 Docutils 的强大和直接。
文档
|
使用 Sphinx 的第一个步骤 |
教程 |
|
|
目录 | 搜索页面 |
|
|
变更 | 通用索引 |
你也可以从右下角的弹出菜单中下载 PDF/EPUB 版本的 Sphinx 文档。
案例
用 Sphinx 生成的文档的链接可以在 使用 Sphinx 的项目 页上找到。
要想知道 Sphinx 源文件的样子，请使用除了这个欢迎页之外的所有文档页面上的 “显示源文件”链接。
你可能也会对非常好的 教程，由 matplotlib 的开发者编写的关于如何使用 Sphinx 创建一个自定义的文档。
在这个文档的 Transifex 中有一个翻译小组，感谢 Sphinx 的文档翻译人员。
一本关于 Sphinx 的日文书已经由 O'Reilly 出版：Sphinxをはじめよう /Learning Sphinx。
2019 年，一本关于 Sphinx 的德文书的第二版已经出版：使用 Sphinx 的软件文档。
托管服务
需要一个地方来托管你的 Sphinx 文档吗？ readthedocs.org 已经托管了很多 Sphinx 文档，并与项目的源代码控制很好地整合。它还具有强大的内置搜索功能，超过了 Sphinx 基于 JavaScript 的离线搜索的可能性。
贡献者指南
如果你想为该项目做出贡献，这部分文件是为你准备的。
行为准则
请遵守我们的 行为守则。