Georg Brandl avatar Georg Brandl committed c5ce9a2

Closes #1076: document new sphinx-build options.

Comments (0)

Files changed (1)


    Do not emit colored output.  (On Windows, colored output is disabled in any
+.. option:: -v
+   Increase verbosity.  This option can be given up to three times to get more
+   debug output.  It implies :option:`-T`.
+   .. versionadded:: 1.2
 .. option:: -q
    Do not output anything on standard output, only write warnings and errors to
    Turn warnings into errors.  This means that the build stops at the first
    warning and ``sphinx-build`` exits with exit status 1.
+.. option:: -T
+   Display the full traceback when an unhandled exception occurs.  Otherwise,
+   only a summary is displayed and the traceback information is saved to a file
+   for further analysis.
+   .. versionadded:: 1.2
 .. option:: -P
    (Useful for debugging only.)  Run the Python debugger, :mod:`pdb`, if an
    unhandled exception occurs while building.
+.. option:: -h, --help, --version
+   Display usage summary or Sphinx version.
+   .. versionadded:: 1.2
 You can also give one or more filenames on the command line after the source and
 build directories.  Sphinx will then try to build only these output files (and
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.