1sphinx-build(1)                  User Commands                 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 files generation.  This is default builder.
30
31       htmlhelp
32              Generates files for CHM generation.
33
34       qthelp Generates files for Qt help collection generation.
35
36       latex  Generates a LaTeX version of the documentation.
37
38       text   Generates a plain-text version of the documentation.
39
40       changes
41              Generates HTML files listing changed/added/deprecated items  for
42              the current version.
43
44       linkcheck
45              Checks the integrity of all external links in the documentation.
46
47       pickle / json
48              Generates serialized HTML files in the selected format.
49
50

OPTIONS

52       -b <builder>
53              Builder  to use; defaults to html. See the full list of builders
54              above.
55
56       -a     Generates output for all files; without this option only  output
57              for new and changed files is generated.
58
59       -E     Ignores  cached  files,  forces to re-read all source files from
60              disk.
61
62       -c <path>
63              Locates the conf.py  file  in  the  specified  path  instead  of
64              <sourcedir>.
65
66       -C     Specifies that no conf.py file at all is to be used.  Configura‐
67              tion can only be set with the -D option.
68
69       -D <setting>=<value>
70              Overrides a setting from the configuration file.
71
72       -d <path>
73              Path to cached files; defaults to <outdir>/.doctrees.
74
75       -A <name>=<value>
76              Passes a value into the HTML templates (only for html builders).
77
78       -N     Prevents colored output.
79
80       -q     Quiet operation, just prints warnings and errors on stderr.
81
82       -Q     Very quiet operation, doesn't print anything except for errors.
83
84       -w <file>
85              Write warnings and errors into the given file,  in  addition  to
86              stderr.
87
88       -W     Turn warnings into errors.
89
90       -P     Runs Pdb on exception.
91

SEE ALSO

93       sphinx-quickstart(1)
94

AUTHOR

96       Georg       Brandl       <georg@python.org>,       Armin       Ronacher
97       <armin.ronacher@active-4.com> et al.
98
99       This manual page was initially  written  by  Mikhail  Gusarov  <dotted‐
100       mag@dottedmag.net>, for the Debian project.
101
102
103
104Sphinx 0.6                         Jan 2009                    sphinx-build(1)