1SPHINX-BUILD(1)                     Sphinx                     SPHINX-BUILD(1)
2
3
4

NAME

6       sphinx-build - Sphinx documentation generator tool
7

SYNOPSIS

9       sphinx-build [options] <sourcedir> <outdir> [filenames ...]
10

DESCRIPTION

12       sphinx-build  generates documentation from the files in <sourcedir> and
13       places it in the <outdir>.
14
15       sphinx-build looks for <sourcedir>/conf.py for the  configuration  set‐
16       tings.   sphinx-quickstart(1)  may  be used to generate template files,
17       including conf.py.
18
19       sphinx-build can create documentation in different formats.   A  format
20       is  selected  by  specifying  the  builder name on the command line; it
21       defaults to HTML.  Builders can also perform  other  tasks  related  to
22       documentation processing.
23
24       By  default,  everything  that  is  outdated is built.  Output only for
25       selected files can be built by specifying individual filenames.
26
27       List of available builders:
28
29       html   HTML file generation.  This is the default builder.
30
31       htmlhelp
32              Generates files for CHM (compiled help files) generation.
33
34       qthelp Generates files for Qt help collection generation.
35
36       devhelp
37              Generates files for the GNOME Devhelp help viewer.
38
39       latex  Generates LaTeX output that can be compiled to a PDF document.
40
41       man    Generates manual pages.
42
43       texinfo
44              Generates Texinfo output that can be processed  by  makeinfo  to
45              generate an Info document.
46
47       text   Generates a plain-text version of the documentation.
48
49       changes
50              Generates  HTML files listing changed/added/deprecated items for
51              the current version of the documented project.
52
53       linkcheck
54              Checks the integrity of all external links in the source.
55
56       pickle / json
57              Generates serialized HTML files for use in web applications.
58

OPTIONS

60       -b <builder>
61              Builder to use; defaults to html. See the full list of  builders
62              above.
63
64       -a     Generate  output  for all files; without this option only output
65              for new and changed files is generated.
66
67       -E     Ignore cached files, forces to re-read  all  source  files  from
68              disk.
69
70       -c <path>
71              Locate  the  conf.py  file  in  the  specified  path  instead of
72              <sourcedir>.
73
74       -C     Specify that no conf.py file at all is to be  used.   Configura‐
75              tion can only be set with the -D option.
76
77       -D <setting=value>
78              Override a setting from the configuration file.
79
80       -d <path>
81              Path to cached files; defaults to <outdir>/.doctrees.
82
83       -A <name=value>
84              Pass a value into the HTML templates (only for HTML builders).
85
86       -n     Run in nit-picky mode, warn about all missing references.
87
88       -N     Prevent colored output.
89
90       -q     Quiet operation, just print warnings and errors on stderr.
91
92       -Q     Very quiet operation, don't print anything except for errors.
93
94       -w <file>
95              Write  warnings  and  errors into the given file, in addition to
96              stderr.
97
98       -W     Turn warnings into errors.
99
100       -P     Run Pdb on exception.
101

SEE ALSO

103       sphinx-quickstart(1)
104

AUTHOR

106       Georg     Brandl     <georg@python.org>,     Armin     Ronacher      <‐
107       armin.ronacher@active-4.com> et al.
108
109       This   manual   page  was  initially  written  by  Mikhail  Gusarov  <‐
110       dottedmag@dottedmag.net>, for the Debian project.
111

113       2007-2011, Georg Brandl
114
115
116
117
1181.1.3                          November 05, 2016               SPHINX-BUILD(1)
Impressum