Skip to content

Commit b88905b

Browse files
committed
Use long options to sphinx-build in our documentation
1 parent fc808e0 commit b88905b

File tree

3 files changed

+8
-6
lines changed

3 files changed

+8
-6
lines changed

doc/development/howtos/builders.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ value.
1313
Builder extensions should define an entry point in the ``"sphinx.builders"``
1414
group. The name of the entry point needs to match your builder's
1515
:attr:`~.Builder.name` attribute, which is the name passed to the
16-
:option:`sphinx-build -b` option. The entry point value should equal the
16+
:option:`sphinx-build --builder` option. The entry point value should equal the
1717
dotted name of the extension module. Here is an example of how an entry point
1818
for 'mybuilder' can be defined in the extension's ``pyproject.toml``
1919

doc/man/sphinx-build.rst

+5-3
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Options
4343
the source and output directories, before any other options are passed.
4444
For example::
4545

46-
sphinx-build -M html ./source ./build -W --keep-going
46+
sphinx-build -M html ./source ./build --fail-on-warning --keep-going
4747

4848
The *make-mode* provides the same build functionality as
4949
a default :ref:`Makefile or Make.bat <makefile_options>`,
@@ -261,8 +261,10 @@ Options
261261

262262
.. option:: --keep-going
263263

264-
With -W option, keep going processing when getting warnings to the end
265-
of build, and ``sphinx-build`` exits with exit status 1.
264+
Only applicable whilst using :option:`--fail-on-warning`,
265+
which by default exits :program:`sphinx-build` on the first warning.
266+
Using :option:`!--keep-going` runs :program:`!sphinx-build` to completion
267+
and exits with exit status 1 if errors are encountered.
266268

267269
.. versionadded:: 1.8
268270

doc/usage/extensions/autodoc.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -765,8 +765,8 @@ There are also config values that you can set:
765765

766766
.. confval:: autodoc_warningiserror
767767

768-
This value controls the behavior of :option:`sphinx-build -W` during
769-
importing modules.
768+
This value controls the behavior of :option:`sphinx-build --fail-on-warning`
769+
during importing modules.
770770
If ``False`` is given, autodoc forcedly suppresses the error if the imported
771771
module emits warnings. By default, ``True``.
772772

0 commit comments

Comments
 (0)