Sphinx——文档生成工具

../_images/sphinx.JPG

Sphinx是用来生成文档的工具,最初专门为Python设计,很多知名的Python项目都采用Sphinx编写的文档。

它使用reStructuredText这一标记语言写文档,可以输出多种格式,包括PDF、HTML和man page等等。Sphinx有apidoc这一扩展,可以自动从python源文件生成API文档。

Sphinx本身用Python编写,可以通过以下命令安装:

pip install -U Sphinx

以下是Sphinx生成的网页版文档的界面:

../_images/home.JPG

以下是一些使用Sphinx编写文档的项目链接: