欢迎

使用者曰:

“为这一伟大工具欢呼吧!总算出现一个令程序员愿意写文档的玩意儿了!”

Sphinx 是种令人可以轻松撰写出明智/优美的文档工具, 由 Georg Brandl 在BSD 许可证下创造.

Sphinx 已支持新版Python文档的生成, 也成为Python项目首选的文档工具,同时也对 C/C++ 工程有很好的支持; 进一步的,也将对其它开发语言进行特殊支持. 当然,本站就是使用 Sphnix 从新结构化文本中创建而成!以下是突出的功能:

  • 输出格式: HTML (包括Windows HTML帮助), LaTeX (可打印的PDF版本), Texinfo, 手册页, 纯文本
  • 交叉引用: 为函数,类,引用,术语和类似信息块生成语义标记和自动链接
  • 分层架构: 很容易的定义文档树,自动链接到同层,父层和子层
  • 自动索引: 为特定语言模块生成索引
  • 代码操作: 使用Pygments高亮器自动高亮代码
  • 扩展应用: 自动代码片段测试, 包含Python模块(API文档)的文档字符串,和更多

Sphinx使用新结构化文本作为它的标记语言, 它的优势来自于强大且直接的结构化文本,及其解析和转换套件Docutils.

文档

你也可以下载Sphinx文档的PDF版: LaTeX Sphinx生成版, 和 rst2pdf 生成版

实例

这些是用sphinx生成文档的项目

想查阅 Sphnix 源文档,点击任何一页的 “显示源文” 链接.

你也可能对由matplotlib开发者撰写的这个非常好的《如何使用Sphinx创建自定义文档》的手册非常感兴趣

本文档的日文翻译 , 谢谢Yoshiki Shibukawa.

本文档由大鼻子通过Google翻译有道词典以及个人智慧完成部分内容.