1. 安装

1.1. 安装Sphinx

1.1.1. Windows

  1. 安装Python

    http://python.org/getit/下载安装 Python2 32位版本,当前版本是python 2.7.5

  2. 添加Python路径到Path环境变量里

    右键点击我的电脑->属性->高级->环境变量,修改系统环境变量里的Path,假设Python安装路径为C:\Python2.7.5,原来的Path%SystemRoot%\system32,则改为:

    %SystemRoot%\system32;C:\Python2.7.5;C:\Python2.7.5\Scripts
  3. 安装Easy_install

    下载http://python-distribute.org/distribute_setup.py到本地,并双击安装。

  4. 安装Sphinx及Livereload

    点击开始->运行->cmd来打开命令提示符,并运行:

    easy_install sphinx livereload

1.1.2. Linux(Debian/Ubuntu)

# apt-get install python-sphinx python-pip
# pip install livereload

1.2. Sphinx版本

推荐使用 Sphinx 1.1.3 及以后的版本。

1.4. 选择合适的编辑器

1.4.1. Windows

选择用对Unix格式换行支持良好、中文显示宽度为英文两倍的编辑器。

编辑器 链接
Sublime text 2 http://www.sublimetext.com
Notepad++ http://notepad-plus-plus.org/
GVim http://www.vim.org/download.php
Eclipse插件 http://marketplace.eclipse.org/content/rest-editor

1.4.2. Linux

Vim、Emacs、GEdit等对reStructuredText都有良好的支持。