欢迎光临

用户说什么：

“为一个能让程序员真正想要的伟大工具干杯“

Sphinx是一种工具，由Georg Brandl编写并根据BSD许可证授权，它使得创造灵活和美观的文档变得容易。

它最初是为 Python文档而创建。它具有出色的设施，可以记录各种语言的软件项目。当然，这个站点（文档）也是使用Sphinx从reStructuredText源创建的！应突出显示以下功能：

输出格式：HTML（包括Windows HTML帮助），LaTex（for printable PDF versions), ePub, Texinfo, manual pages, plain text
广泛的交叉引用： 语义标记和函数，类，引用，术语和类似信息的自动链接
层次结构：轻松定义文档树，自动链接到兄弟姐妹，父母和孩子。
自动索引： 通用索引，以及用于特定语言的模块索引
代码处理： 使用Pygments 自动高亮显示
扩展： 自动测试代码片段，包含Python模块中的文档字符串（API文档），及更多
贡献的扩展： more than 在其他仓储库中由用户贡献的 50余扩展，大部分可以通过 PyPI 安装。

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

文档

您还可以下载sphinx文档的pdf/epub版本

查看使用Sphinx生成的文档的链接：使用 Sphinx 的项目页面。

有关sphinx源文件外观的示例，请使用 “Show source” 链接显示。

你也可能对教程非常有兴趣，关于如何使用 Matplotlib开发人员编写的Sphinx创建自定义文档。

transifex中有一个翻译团队

O'Reilly 出版了一本关于Sphinx的日语图书：Sphinxをはじめよう Learning Sphinx.

2019年，德国出版了第二版关于Sphinx的书： Software-Dokumentation mit Sphinx.

需要一个地方来托管你的 Sphinx 文档吗？ readthedocs.org 已经拥有很多Sphinx文档，并且与项目的源代码控制很好地集成。它还具有强大的内置搜索功能，超出了Sphinx基于JavaScript的离线搜索功能。

如果你想为这个项目做贡献，