Sphinx 初始化项目
Welcome to the Sphinx 1.5.6 quickstart utility.
Please enter values for the following settings (just press Enter to
accept a default value, if one is given in brackets).
Enter the root path for documentation.
> Root path for the documentation [.]: 欢迎来到Sphinx 1.5.6快速启动程序
请输入下面的提示设置(接受默认值按回车)
>选为文档择根目录[.]
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]: 你有两个选择来存放输出文件。
直接选择在根目录下建立”_build”文件夹或者分开”source”和”build”路径，
>分离source和build文件夹(y/n)[n]:
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 [_]: 在根目录下会创建模板目录”_templates”和静态文件目录”static”。你可以更改他们的前缀。
>templates和static目录文件夹的前缀[_]:
The project name will occur in several places in the built documentation.
> Project name: 输入项目的名称，这个名称会在网页中显示
>项目名称:
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]:
If the documents are to be written in a language other than English,
you can select a language here by its language code. Sphinx will then
translate text that it generates into that language.
For a list of supported codes, see
http://sphinx-doc.org/config.html#confval-language.
> Project language [en]: 选择项目的语言
> 项目语言[en]:
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]: 选择项目文件的后缀，只有包含该后缀的文件会被sphinx渲染
> 源文件后缀[.rst]:
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]: 设置根文件，这个文件包含了”contents tree”，就是索引页
> 设置根文件[index]:
Sphinx can also add configuration for epub output:
> Do you want to use the epub builder (y/n) [n]: 可以为输出epub配置
> 是否使用epub输出(y/n)[n]:
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]:
> 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]:
> coverage: checks for documentation coverage (y/n) [n]:
> imgmath: include math, rendered as PNG or SVG 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]:
> githubpages: create .nojekyll file to publish the document on GitHub pages (y/n) [n]:
是否使用一下的拓展：
> autodoc:自动为模块生成文档(y/n) [n]:
> doctest:
> intersphinx:
> todo
> coverage
> imgmath
> mathjax
> ifconfig
> viewcode
> githubpages
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]: 是否创建makefile，来使用make html替代sphinx-build
> 创建makefile(y/n) [y]:
> 创建win 命令行文件? (y/n) [y]:
完成之后会生成如下模板
.
├── build # 输出文档
├── make.bat # win下的生成命令
├── Makefile # linux下的生成命令
└── source
├── conf.py # 生成的配置
├── index.rst # 索引文件
├── _static # 静态文件
└── _templates # 模板文件