python文档生成器
Sphinx的Python项目详细描述
狮身人面像是一种很容易创造智慧和美丽的工具 python项目的文档（或由多个 由乔治布兰德撰写。它最初是被创造出来的 对于新的python文档，并具有优秀的python工具 项目文档，但也支持C/C++，更多的语言是 计划。
sphinx使用structuredtext作为标记语言，它的许多优点 来自于重构文本的力量和直截了当性及其解析 翻译套件，文档。
其特点如下：
- 输出格式：HTML（包括派生格式，如HTML帮助、ePub 和qt帮助），纯文本，手动页面和乳胶或直接pdf输出 使用rst2pdf
- 广泛的交叉引用：语义标记和自动链接 对于函数、类、词汇表术语和类似的信息
- 层次结构：文档树的简单定义，自动 指向兄弟姐妹、父母和子女的链接
- 自动索引：常规索引和模块索引
- 代码处理：使用pygments highlighter自动突出显示
- 使用JIJA 2模板引擎 的灵活HTML输出
- 可以使用各种扩展，例如用于自动测试代码段 以及包含适当格式的docstring
- setuptools集成
有关详细信息，请参阅the documentation。
安装
sphinx发布在PyPI上，可以从那里安装：
pip install -U sphinx
我们还发布测试版：
pip install -U --pre sphinx
如果您希望安装sphinx以进行开发，请参阅the contributors guide。
文档
文档可从sphinx-doc.org获得。
联系
- 报告错误、建议功能或查看源代码on GitHub。
- 对于不太明确的问题或想法，请使用mailing list。
测试
连续测试由Travis提供（用于单元测试和样式检查 在linux上，AppVeyor（用于windows上的单元测试）和CircleCI（用于 像tex编译这样的大型过程）。
有关在本地运行测试的信息，请参阅the contributors guide。
贡献
欢迎加入QQ群-->： 979659372
