blob: aa1d71c64ea5c35abced969644a37316f918de42 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
:orphan:
sphinx-build manual page
========================
Synopsis
--------
**sphinx-build** [*options*] <*sourcedir*> <*outdir*> [*filenames* ...]
Description
-----------
:program:`sphinx-build` generates documentation from the files in
``<sourcedir>`` and places it in the ``<outdir>``.
:program:`sphinx-build` looks for ``<sourcedir>/conf.py`` for the configuration
settings. :manpage:`sphinx-quickstart(1)` may be used to generate template
files, including ``conf.py``.
:program:`sphinx-build` can create documentation in different formats. A format
is selected by specifying the builder name on the command line; it defaults to
HTML. Builders can also perform other tasks related to documentation
processing.
By default, everything that is outdated is built. Output only for selected
files can be built by specifying individual filenames.
List of available builders:
html
HTML file generation. This is the default builder.
dirhtml
HTML file generation with every HTML file named "index.html" in a separate
directory.
singlehtml
HTML file generation with all content in a single HTML file.
htmlhelp
Generates files for CHM (compiled help files) generation.
qthelp
Generates files for Qt help collection generation.
devhelp
Generates files for the GNOME Devhelp help viewer.
latex
Generates LaTeX output that can be compiled to a PDF document.
man
Generates manual pages.
texinfo
Generates Texinfo output that can be processed by :program:`makeinfo` to
generate an Info document.
epub
Generates an ePub e-book version of the HTML output.
text
Generates a plain-text version of the documentation.
gettext
Generates Gettext message catalogs for content translation.
changes
Generates HTML files listing changed/added/deprecated items for
the current version of the documented project.
linkcheck
Checks the integrity of all external links in the source.
pickle / json
Generates serialized HTML files for use in web applications.
xml
Generates Docutils-native XML files.
pseudoxml
Generates compact pretty-printed "pseudo-XML" files displaying the
internal structure of the intermediate document trees.
Options
-------
-b <builder> Builder to use; defaults to html. See the full list
of builders above.
-a Generate output for all files; without this option only
output for new and changed files is generated.
-E Ignore cached files, forces to re-read all source files
from disk.
-d <path> Path to cached files; defaults to <outdir>/.doctrees.
-j <N> Build in parallel with N processes where possible.
-c <path> Locate the conf.py file in the specified path instead of
<sourcedir>.
-C Specify that no conf.py file at all is to be used.
Configuration can only be set with the -D option.
-D <setting=value> Override a setting from the configuration file.
-t <tag> Define *tag* for use in "only" blocks.
-A <name=value> Pass a value into the HTML templates (only for HTML builders).
-n Run in nit-picky mode, warn about all missing references.
-v Increase verbosity (can be repeated).
-N Prevent colored output.
-q Quiet operation, just print warnings and errors on stderr.
-Q Very quiet operation, don't print anything except for errors.
-w <file> Write warnings and errors into the given file, in addition
to stderr.
-W Turn warnings into errors.
-T Show full traceback on exception.
-P Run Pdb on exception.
See also
--------
:manpage:`sphinx-quickstart(1)`
Author
------
Georg Brandl <georg@python.org>, Armin Ronacher <armin.ronacher@active-4.com> et
al.
This manual page was initially written by Mikhail Gusarov
<dottedmag@dottedmag.net>, for the Debian project.
|
