欢迎
Sphinx是一个工具,它使得创建智能而且美观的文档非常容易,由Georg Brandl编写,并根据BSD许可证授权。
它最初是为Python文档创建的,但是现在它为好几种语言的软件项目文档提供极好的工具。当然,这个网站也是从reStructuredText源使用Sphinx创建的!以下功能应该特别强调一下:
- 输出格式: HTML(包括Windows HTML帮助)、LaTeX(适用于可打印的PDF版本)、ePub、Texinfo、手册页、纯文本
- 广泛的交叉引用:语义标记和函数、类、引文、词汇表术语和类似信息的自动链接
- 分层结构:文档树定义简单,自动链接到兄弟姐妹、父母和孩子
- 自动索引:一般索引以及特定于语言的模块索引
- 代码处理:使用Pygments自动突出显示
- 扩展程序:自动测试代码段,包含来自Python模块的文档字符串(API文档)和更多
- 提供的扩展程序:第二个repository中超过50个由用户提供的扩展;大多数可以从PyPI安装
Sphinx使用reStructuredText作为其标记语言,其许多优势来自reStructuredText及其解析和翻译套件(Docutils)的强大和直接性。
文档
Sphinx的第一步 目录 | 搜索页 通用索引 |
你还可以下载Sphinx文档的PDF/EPUB版本:从LaTeX Sphinx产品生成的PDF版本和EPUB版本。
例子
使用Sphinx生成的文档的链接可以在使用Sphinx的项目页面上找到。
有关Sphinx源文件外观的示例,请使用除本欢迎页面之外的文档的所有页面上的“显示源代码”链接。
你也可能对这本非常好的关于如何使用Sphinx创建自定义文档的教程感兴趣,它由matplotlib开发人员编写的。
感谢日语Sphinx用户组,本文档有一个日语翻译。
有关Sphinx的日语书籍已由O'Reilly出版:Sphinxをはじめよう/ Learning Sphinx。
托管
需要一个地方来托管您的Sphinx文档?readthedocs.org已经拥有大量Sphinx文档,并且与项目的源代码控制很好地集成。它还具有强大的内置搜索功能,超越了Sphinx基于JavaScript的离线搜索的可能性。
贡献者指南
如果你想为项目做贡献,这部分文档是给你的。