IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Closes #1156: bring manpage up to scratch with current options and builders.

Browse Source
This commit is contained in:
Georg Brandl 2014-01-12 16:07:21 +01:00
parent 1ddedb523e
commit 31aed07386
1 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/man/sphinx-build.rst
View File

@ -32,6 +32,13 @@ List of available builders:
html html
HTML file generation. This is the default builder. 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 htmlhelp
Generates files for CHM (compiled help files) generation. Generates files for CHM (compiled help files) generation.
@ -51,9 +58,15 @@ texinfo
Generates Texinfo output that can be processed by :program:`makeinfo` to Generates Texinfo output that can be processed by :program:`makeinfo` to
generate an Info document. generate an Info document.
epub
Generates an ePub e-book version of the HTML output.
text text
Generates a plain-text version of the documentation. Generates a plain-text version of the documentation.
gettext
Generates Gettext message catalogs for content translation.
changes changes
Generates HTML files listing changed/added/deprecated items for Generates HTML files listing changed/added/deprecated items for
the current version of the documented project. the current version of the documented project.
@ -81,20 +94,24 @@ Options
output for new and changed files is generated. output for new and changed files is generated.
-E Ignore cached files, forces to re-read all source files -E Ignore cached files, forces to re-read all source files
from disk. 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 -c <path> Locate the conf.py file in the specified path instead of
<sourcedir>. <sourcedir>.
-C Specify that no conf.py file at all is to be used. -C Specify that no conf.py file at all is to be used.
Configuration can only be set with the -D option. Configuration can only be set with the -D option.
-D <setting=value> Override a setting from the configuration file. -D <setting=value> Override a setting from the configuration file.
-d <path> Path to cached files; defaults to <outdir>/.doctrees. -t <tag> Define *tag* for use in "only" blocks.
-A <name=value> Pass a value into the HTML templates (only for HTML builders). -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. -n Run in nit-picky mode, warn about all missing references.
-v Increase verbosity (can be repeated).
-N Prevent colored output. -N Prevent colored output.
-q Quiet operation, just print warnings and errors on stderr. -q Quiet operation, just print warnings and errors on stderr.
-Q Very quiet operation, don't print anything except for errors. -Q Very quiet operation, don't print anything except for errors.
-w <file> Write warnings and errors into the given file, in addition -w <file> Write warnings and errors into the given file, in addition
to stderr. to stderr.
-W Turn warnings into errors. -W Turn warnings into errors.
-T Show full traceback on exception.
-P Run Pdb on exception. -P Run Pdb on exception.