Sphinx是一个文本转换工具,用于把reStructuredText的文档转换成其它格式(如静态HTML文件),自动生成交叉引用,目录等。Sphinx可以生成LaTex文件,进而你可以生成PDF文件;或者使用rst2pdf直接生成PDF文件。
Sphinx最早由Georg Brandl在2008/03/21发布,截止2017/04/03最新版本是1.5.6。
官方网站: http://www.sphinx-doc.org/en/stable/
1. Python要求
Python 2.7或Pythoh 3.4之后的版本,同时需要安装docutils和jinja2库。
2. 安装Sphinx
官方安装教程,指引如何在各个操作系统上安装:
http://www.sphinx-doc.org/en/stable/install.html
下面整理了如何在Windows上安装Sphinx。
2.1 使用pip安装
安装Python
并在环境变量PATH中添加下面两个路径:
- C:\Python27 — 包含python执行的主要程序。
- C:\Python27\Scripts — 包含通过使用pip安装的可执行程序。
安装pip命令
Python提供了pip命令,可以一键安装第三方包。下载pip:https://bootstrap.pypa.io/get-pip.py 保存到一个地方,进入目录安装
C:\> python get-pip.py
安装Sphinx
C:\> pip install sphinx
install是安装命令,后面跟安装什么便可,不分大小写。像我以前使用的Thrift也可以这样安装。
C:\> pip install thrift
2.2 下载包自行安装
https://pypi.python.org/pypi/Sphinx
下载完后,进入目录:
python setup.py install