1
sphinx-quickstart #快速创建项目
2

3

4
# 1.设置项目的根目录
5
Enter the root path for documentation.
6
> Root path for the documentation [.]:
7

8
# 2.是否分离build和source目录（一半选择n）
9
You have two options for placing the build directory for Sphinx output.
10
Either, you use a directory "_build" within the root path, or you separate
11
"source" and "build" directories within the root path.
12
> Separate source and build directories (y/n) [n]:
13

14
# 3.设置前缀（默认）
15
Inside the root directory, two more directories will be created; "_templates"
16
for custom HTML templates and "_static" for custom stylesheets and other static
17
files. You can enter another prefix (such as ".") to replace the underscore.
18
> Name prefix for templates and static dir [_]:
19

20
# 4.输入项目的名称和作者
21
The project name will occur in several places in the built documentation.
22
> Project name: Sphinx-test
23
> Author name(s): test
24

25
# 5. 输入项目的版本号
26
Sphinx has the notion of a "version" and a "release" for the
27
software. Each version can have multiple releases. For example, for
28
Python the version is something like 2.5 or 3.0, while the release is
29
something like 2.5.1 or 3.0a1.  If you don't need this dual structure,
30
just set both to the same value.
31
> Project version []: 1.0.0
32
> Project release [1.0.0]:
33

34
# 6.文档语言
35
If the documents are to be written in a language other than English,
36
you can select a language here by its language code. Sphinx will then
37
translate text that it generates into that language.
38

39
For a list of supported codes, see
40
http://sphinx-doc.org/config.html#confval-language.
41
> Project language [en]:
42

43
# 7. 设定文档的后缀
44
The file name suffix for source files. Commonly, this is either ".txt"
45
or ".rst".  Only files with this suffix are considered documents.
46
> Source file suffix [.rst]:
47

48
# 8.设定首页名称
49
One document is special in that it is considered the top node of the
50
"contents tree", that is, it is the root of the hierarchical structure
51
of the documents. Normally, this is "index", but if your "index"
52
document is a custom template, you can also set this to another filename.
53
> Name of your master document (without suffix) [index]:
54

55
# 9.创建项目
56
A Makefile and a Windows command file can be generated for you so that you
57
only have to run e.g. `make html' instead of invoking sphinx-build
58
directly.
59
> Create Makefile? (y/n) [y]: y
60
> Create Windows command file? (y/n) [y]: y
61

62
Creating file ./conf.py.
63
Creating file ./index.rst,.md.
64
Creating file ./Makefile.
65
Creating file ./make.bat.
66

67
Finished: An initial directory structure has been created.
68

69
You should now populate your master file ./index.rst,.md and create other documentation
70
source files. Use the Makefile to build the docs, like so:
71
   make builder
72
where "builder" is one of the supported builders, e.g. html, latex or linkcheck.