Sphinx是一个工具,她能够轻易地创建智慧和优雅的文档,她是出自Georg Brandl之手,在BSD许可证下授权。
她最初是为了新版的python文档, 因此在python项目的文档具有完美的特性,但是同样支持c/c++,目前正在计划增加对其他的语言的支持。 理所当然,本页面也是使用Sphinx创造自reStructuredText格式源!Sphinx具有如下的特点:
Sphinx 使用 reStructuredText 作为她的标记语言,她的优点大部分是来自于reStructuredText 以及reStructuredText的解析和转换工具(套件)Docutils的强大以及简单明了。
初熟Sphinx 目录 |
搜索页 通用索引 |
你也能下载PDF格式的Sphinx文档:一种PDF 版本 是由LaTeX Sphinx生成,另一种PDF 版本 是由rst2pdf生成。
用Sphinx生成文档的项目能够在 Projects using Sphinx上找到。
想要查看Sphinx源文件长得什么样的话,可以在除本欢迎页外的任何页面上使用“显示网页源代码”。
你也许对这份十分不错 教程感兴趣,它是由matplotlib的开发者编写,是使用了Sphinx创建地自定义的文档。
Sphinx是一个可用的 easy-install包在 Python Package Index.
源码能够在下面的地址中找到: http://bitbucket.org/birkenfeld/sphinx/。