Sphinx简介

Sphinx是什么？

Sphinx是一种文档工具，它可以令人轻松的撰写出清晰且优美的文档。Python的官方文档即是由Sphinx生成。现在，Sphinx已成为Python项目首选的文档工具，同时它对C/C++项目也有很好的支持，并计划对其它开发语言添加特殊支持。Sphinx的页面用reStructuredText（一种结构化标记语言）写成。Sphinx具有以下特性：

• 丰富的输出格式: 支持 HTML (包括 Windows 帮助文档)，LaTeX (可以打印PDF版本)，manual pages（man 文档），纯文本
• 完备的交叉引用: 语义化的标签，并可以自动化链接函数，类，引文，术语及相似的片段信息
• 明晰的分层结构: 可以轻松的定义文档树，并自动化链接同级/父级/下级文章
• 美观的自动索引: 可自动生成美观的模块索引
• 精确的语法高亮: 基于 Pygments 自动生成语法高亮
• 开放的扩展: 支持代码块的自动测试，并包含Python模块的自述文档(API docs)等

你能用从本帮助文档中学到什么？

• 在Windows、Mac或Linux上安装Sphinx
• reStructuredText的基本语法
• 在Sphinx中用RST（reStructuredText）语言进行创作
• 将文档生成为html或pdf文件
• 将文档托管至Readthedocs，实现文档自动更新