使用Sphinx制作說明文檔

Sphinx允許開發人員以純文本格式編寫文檔，以便采用滿足不 同需求的格式輕松生成輸出。雖然 Sphinx 是用 Python 編寫的，并且最初是為 Python 語言文檔而創建，但它并不一定是以語言為中心，在某些情況下，甚至不是以程序員為中心。Sphinx 有許多用處，比如可以用它來編寫整本書！

可以將 Sphinx 想像成為一種文檔框架：它會抽象化比較單調的部分，并提供自動函數來解決一些常見問題，比如突出顯示標題索引和特殊代碼（在顯示代碼示例時），以及突出顯示適當的語法。

簡單來說，Sphinx 是一個基于ReStructuredText的文檔生成工具。方便易用，功能強大。很多著名 python 項目都使用了 sphinx 生成自己的文檔，比如：python 官方文檔、tornado 框架文檔等。

一、在Windows上安裝Sphinx

如果你的Windows電腦已經安裝好了Python或Pip的話，步驟非常的簡單，只需要在CMD窗口中執行 pip install Sphinx，然后等待執行完畢就OK。

二、建立Sphinx項目

建議使用sphinx自帶的配置工具sphinx-quickstart。 – 建立一個工程目錄，比如F\:Note。 – 在該目錄啟動命令行，輸入sphinx-quickstart

F:\Note>sphinx-quickstart
Welcome to the Sphinx 1.1.3 quickstart utility.

Please enter values for the following settings (just press Enter to
accept a default value, if one is given in brackets).

1、設定文檔的根路徑（直接回車，采用默認設置）

Enter the root path for documentation.
> Root path for the documentation [.]:

2、分離source和build目錄（采用分離，可便于管理）

You have two options for placing the build directory for Sphinx output.
Either, you use a directory “_build” within the root path, or you separate
“source” and “build” directories within the root path.
> Separate source and build directories (y/N) [n]: y

3、設定模板前綴（直接回車即可）

Inside the root directory, two more directories will be created; “_templates”
for custom HTML templates and “_static” for custom stylesheets and other static
files. You can enter another prefix (such as “.”) to replace the underscore.
> Name prefix for templates and static dir [_]:

4、制定項目名稱、作者及版本號

The project name will occur in several places in the built documentation.
> Project name: myNote
> Author name(s): QW

Sphinx has the notion of a “version” and a “release” for the
software. Each version can have multiple releases. For example, for
Python the version is something like 2.5 or 3.0, while the release is
something like 2.5.1 or 3.0a1.  If you don’t need this dual structure,
just set both to the same value.
> Project version: 1.0.1
> Project release [1.0.1]:

5、設定文檔文件的后綴，默認是.rst，推薦設置.txt

The file name suffix for source files. Commonly, this is either “.txt”
or “.rst”.  Only files with this suffix are considered documents.
> Source file suffix [.rst]: .txt

6、設定首頁的名字，默認index就好了，不用改。

One document is special in that it is considered the top node of the
“contents tree”, that is, it is the root of the hierarchical structure
of the documents. Normally, this is “index”, but if your “index”
document is a custom template, you can also set this to another filename.
> Name of your master document (without suffix) [index]:

7、是否要設定epub輸出，基本不用No即可

Sphinx can also add configuration for epub output:
> Do you want to use the epub builder (y/N) [n]: N

8、設定是否需要使用Sphinx拓展功能

Please indicate if you want to use one of the following Sphinx extensions:
> autodoc: automatically insert docstrings from modules (y/N) [n]: y
> doctest: automatically test code snippets in doctest blocks (y/N) [n]: y
> intersphinx: link between Sphinx documentation of different projects (y/N) [n]: y
> todo: write “todo” entries that can be shown or hidden on build (y/N) [n]: y
> coverage: checks for documentation coverage (y/N) [n]: y
> pngmath: include math, rendered as PNG images (y/N) [n]: y
> mathjax: include math, rendered in the browser by MathJax (y/N) [n]: y
Note: pngmath and mathjax cannot be enabled at the same time.
pngmath has been deselected.
> ifconfig: conditional inclusion of content based on config values (y/N) [n]: y
> viewcode: include links to the source code of documented Python objects (y/N) [n]: y

9、創建項目

A Makefile and a Windows command file can be generated for you so that you only have to run e.g. `make html’ instead of invoking sphinx-build directly. > Create Makefile? (Y/n) [y]: y > Create Windows command file? (Y/n) [y]: y

Creating file .\source\conf.py.
Creating file .\source\index.txt.
Creating file .\Makefile.
Creating file .\make.bat.

Finished: An initial directory structure has been created.

You should now populate your master file .\source\index.txt and create other documentation
source files. Use the Makefile to build the docs, like so:
make builder
where “builder” is one of the supported builders, e.g. html, latex or linkcheck.

10、生成HTML文件

F:\Note>make html
Making output directory…
Running Sphinx v1.1.3
loading pickled environment… not yet created
loading intersphinx inventory from http://docs.python.org/objects.inv…
building [html]: targets for 1 source files that are out of date
updating environment: 1 added, 0 changed, 0 removed
reading sources… [100%] index

looking for now-outdated files… none found
pickling environment… done
checking consistency… done
preparing documents… done
writing output… [100%] index

writing additional files… (0 module code pages) genindex search
copying static files… done
dumping search index… done
dumping object inventory… done
build succeeded.

Build finished. The HTML pages are in build/html.

如果要生成文檔，在source目錄下新建txt文件即可，然后運行make html，另外如果txt中存在中文，則需要將txt保存為utf-8格式。

來自：http://www.biaodianfu.com/sphinx-documentation.html