[关闭]
@52fhy 2016-01-23T13:58:11.000000Z 字数 947 阅读 960

使用sphinx生成文档

Python 工具


Sphinx 是一种工具,它允许开发人员以纯文本格式编写文档,以便采用满足不同需求的格式轻松生成输出。这在使用 Version Control System 追踪变更时非常有用。纯文本文档对不同系统之间的协作者也非常有用。纯文本是当前可以采用的最便捷的格式之一。

虽然 Sphinx 是用 Python 编写的,并且最初是为 Python 语言文档而创建,但它并不一定是以语言为中心,在某些情况下,甚至不是以程序员为中心。Sphinx 有许多用处,比如可以用它来编写整本书!

可以将 Sphinx 想像成为一种文档框架:它会抽象化比较单调的部分,并提供自动函数来解决一些常见问题,比如突出显示标题索引和特殊代码(在显示代码示例时),以及突出显示适当的语法。

安装

Sphinx依赖于Python以及需要安装命令行工具easy_install。

安装python

请自行到官网https://www.python.org/downloads下载并安装Python。

安装easy_install工具

setuptools工具的网址是:
https://pypi.python.org/pypi/setuptools

安装方法很多。我们最终都可以使用python ez_setup.py来安装setuptools。

ez_setup.py的地址是:https://bootstrap.pypa.io/ez_setup.py

下载ez_setup.py后,在命令行输入:

  1. python ez_setup.py

进行安装。提示:

  1. ...
  2. Installed d:\program files\python27\lib\site-packages\setuptools-19.4-py2.7.egg
  3. Processing dependencies for setuptools==19.4
  4. Finished processing dependencies for setuptools==19.4

安装sphinx

安装命令:

  1. easy_install sphinx

easy_install可以自动下载并安装sphinx以及它所依赖的其他模块。

安装完成后,命令行会提示Finished processing dependencies for sphinx

生成文档

添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注