嗨!

用户有曰:

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

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

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

Sphnix还在继续开发. 下列特性工作良好,并在Python官方文档中有“体现”:

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

Sphinx 使用新结构化文本 作为标记语言,因而直接享受了来自Docutils 为 reStructuredText 提供的多种工具和能力!

Documentation

初尝 基本作業概览 内容 完整索引

搜索 搜索文档 索引 所有函式/类/条目

有Sphnix 文档的PDF版本下载: 基于 LaTeX Sphinx 的版本 , 以及 使用rst2pdf 生成的版本 .

实例

收集了那些 使用Sphnix 的项目 文档入口链接.

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

请跟随由matplotlib开发人员组织的,非常简洁的教程, 来体验如何运用 Sphnix 创建文档!

这儿是当前文档的日文翻译, 感谢Yoshiki Shibukawa.

本文是 中文译本 由 Zoom.Quiet 私人创建.

获取 Sphinx

Sphinx 释放有 easy-install支持的模块, 可在 Python 模块索引中查阅到.

所有代码可在水银仓库中克隆到: http://bitbucket.org/birkenfeld/sphinx/.