mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2026-11-02 20:30:30 -06:00
Use long options to sphinx-build in our documentation
This commit is contained in:
1 parent
fc808e0e90
commit
b88905b6f7
3 files changed
+8
-6
No files matched your search
@@ -13,7 +13,7 @@ value.
|
|||||||
Builder extensions should define an entry point in the ``"sphinx.builders"``
|
Builder extensions should define an entry point in the ``"sphinx.builders"``
|
||||||
group. The name of the entry point needs to match your builder's
|
group. The name of the entry point needs to match your builder's
|
||||||
:attr:`~.Builder.name` attribute, which is the name passed to the
|
:attr:`~.Builder.name` attribute, which is the name passed to the
|
||||||
:option:`sphinx-build -b` option. The entry point value should equal the
|
:option:`sphinx-build --builder` option. The entry point value should equal the
|
||||||
dotted name of the extension module. Here is an example of how an entry point
|
dotted name of the extension module. Here is an example of how an entry point
|
||||||
for 'mybuilder' can be defined in the extension's ``pyproject.toml``
|
for 'mybuilder' can be defined in the extension's ``pyproject.toml``
|
||||||
|
|
||||||
|
|||||||
@@ -43,7 +43,7 @@ Options
|
|||||||
the source and output directories, before any other options are passed.
|
the source and output directories, before any other options are passed.
|
||||||
For example::
|
For example::
|
||||||
|
|
||||||
sphinx-build -M html ./source ./build -W --keep-going
|
sphinx-build -M html ./source ./build --fail-on-warning --keep-going
|
||||||
|
|
||||||
The *make-mode* provides the same build functionality as
|
The *make-mode* provides the same build functionality as
|
||||||
a default :ref:`Makefile or Make.bat <makefile_options>`,
|
a default :ref:`Makefile or Make.bat <makefile_options>`,
|
||||||
@@ -261,8 +261,10 @@ Options
|
|||||||
|
|
||||||
.. option:: --keep-going
|
.. option:: --keep-going
|
||||||
|
|
||||||
With -W option, keep going processing when getting warnings to the end
|
Only applicable whilst using :option:`--fail-on-warning`,
|
||||||
of build, and ``sphinx-build`` exits with exit status 1.
|
which by default exits :program:`sphinx-build` on the first warning.
|
||||||
|
Using :option:`!--keep-going` runs :program:`!sphinx-build` to completion
|
||||||
|
and exits with exit status 1 if errors are encountered.
|
||||||
|
|
||||||
.. versionadded:: 1.8
|
.. versionadded:: 1.8
|
||||||
|
|
||||||
|
|||||||
@@ -765,8 +765,8 @@ There are also config values that you can set:
|
|||||||
|
|
||||||
.. confval:: autodoc_warningiserror
|
.. confval:: autodoc_warningiserror
|
||||||
|
|
||||||
This value controls the behavior of :option:`sphinx-build -W` during
|
This value controls the behavior of :option:`sphinx-build --fail-on-warning`
|
||||||
importing modules.
|
during importing modules.
|
||||||
If ``False`` is given, autodoc forcedly suppresses the error if the imported
|
If ``False`` is given, autodoc forcedly suppresses the error if the imported
|
||||||
module emits warnings. By default, ``True``.
|
module emits warnings. By default, ``True``.
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user