diff options
| author | Georg Brandl <georg@python.org> | 2009-02-17 19:19:09 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2009-02-17 19:19:09 +0100 |
| commit | 9cb11f9ae00b09e83105afb390ca1053c84ee84f (patch) | |
| tree | 315f2b91aaa85c32a231975c50be3c023e7c1070 /doc/intro.rst | |
| parent | 3e808fe07b9167b5a40f56b61ea3ce016f8a6b1b (diff) | |
| download | sphinx-9cb11f9ae00b09e83105afb390ca1053c84ee84f.tar.gz | |
There is now a ``-W`` option for sphinx-build that turns warnings into errors.
^
Diffstat (limited to 'doc/intro.rst')
| -rw-r--r-- | doc/intro.rst | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/intro.rst b/doc/intro.rst index f9e23e18..782328be 100644 --- a/doc/intro.rst +++ b/doc/intro.rst @@ -133,6 +133,10 @@ The :program:`sphinx-build` script has several more options: Do not output anything on standard output, also suppress warnings. Only errors are written to standard error. +**-W** + Turn warnings into errors. This means that the build stops at the first + warning and ``sphinx-build`` exits with exit status 1. + **-P** (Useful for debugging only.) Run the Python debugger, :mod:`pdb`, if an unhandled exception occurs while building. |