欢迎
Sphinx是一个工具，可以轻松创建由Georg Brandl编写并根据BSD许可证授权的智能和美观文档
它最初是为Python文档创建的，它具有出色的工具，可用于各种语言的软件项目文档。 当然，这个站点也是使用reStructuredText源创建的
- 输出格式: HTML（包括Windows HTML帮助），LaTeX（适用于可打印的PDF版本），ePub，Texinfo，手册页，纯文本
- 广泛的交叉引用: 语义标记和功能，类，引用，词汇表术语和类似信息的自动链接
- 分层结构: 轻松定义文档树，自动链接到平级，上级和下级
- 自动索引: 一般索引以及特定于语言的模块索引
- 代码处理: 使用Pygments荧光笔自动突出显示
- 扩展: 自动测试代码片段，包含Python模块（API文档）中的文档字符串等
- 贡献的扩展: 用户在第二个存储库中贡献了50多个扩展;其中大多数可以从PyPI安装
Sphinx使用reStructuredText作为其标记语言，其许多优点来自reStructuredText及其解析和翻译套件Docutils的强大功能和直接性。
文档
|
入门 | 搜索页 |
|
目录 | 总目录 |
|
变化 |
您也可以从右下角的弹出菜单下载Sphinx文档的PDF/EPUB版本。
实际案例
可以在使用Sphinx的Projects页面上找到使用Sphinx生成的文档的链接。
有关Sphinx源文件外观的示例，请使用除此欢迎页面之外的文档所有页面上的“显示源”链接。
您可能还对如何使用matplotlib开发人员编写的Sphinx创建自定义文档的非常好的教程感兴趣
感谢日本Sphinx用户组，该文档有日文翻译。
O'Reilly出版了一本关于Sphinx的日语书:Sphinxをはじめよう/Learning Sphinx
主机
需要一个地方来托管你的Sphinx文档？ readthedocs.org已经托管了许多Sphinx文档，并且与项目的源代码控制很好地集成。 它还具有强大的内置搜索功能，超出了Sphinx基于JavaScript的离线搜索功能。
贡献者指南
如果您想为项目做出贡献，这部分文档适合您。