Sphinx Introducation: Python Documentation Generator

Sphinx Introducation: Python Documentation Generator

• Author: Chao Zhong（钟超）
• Email: zhongchao.ustc#gmail.com (#->@)
• Blog: Blog.CSDN.net/Poechant
• Date: Sep 30, 2012

---

0 Install Sphinx

easy_install -U Sphinx

1 Build Project

1.1 sphinx-quickstart

michael@ubuntu:~/release/sphinx$ 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.2 Root path for the documentation

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

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

1.3 Name prefix for templates and static dir

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 [_]: 

1.4 Project name

The project name will occur in several places in the built documentation.
> Project name: NginxCreed 

1.5 Author name

> Author name(s): Chao Zhong

1.6 Project version

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: 0.1
> Project release [0.1]: 

1.7 Source file suffix

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]: 

1.8 Name of your master document (without suffix)

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]: 

1.9 Do you want to use the epub builder

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

1.10 Other questions

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

1.11 Create Makefile/Create Windows command file

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]: 
> Create Windows command file? (Y/n) [y]: 

2 Make HTML

在刚才执行 sphinx-quickstart 的目录下，运行：

make html

会将 Sphinx 提供的默认测试文件生成 HTML，然后配置好 Web 服务器，在浏览器里面通过 HTTP 协议访问，或者直接通过 FILE 协议访问。

Reference

1. http://sphinx.pocoo.org
2. http://www.cnblogs.com/qiyeshublog/articles/2379269.html

-

转载请注明来自柳大·Poechant（钟超）的CSDN博客：Blog.CSDN.net/Poechant

-