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       text   Generates a plain-text version of the documentation.
44
45       changes
46              Generates HTML files listing changed/added/deprecated items  for
47              the current version of the documented project.
48
49       linkcheck
50              Checks the integrity of all external links in the source.
51
52       pickle / json
53              Generates serialized HTML files for use in web applications.
54

OPTIONS

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

SEE ALSO

99       sphinx-quickstart(1)
100

AUTHOR

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

109       2007-2011, Georg Brandl
110
111
112
113
1141.0.7                          January 18, 2011                SPHINX-BUILD(1)
Impressum