Skip to content

Commit

Permalink
Use long options to sphinx-build in our documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
AA-Turner committed Jul 24, 2024
1 parent fc808e0 commit b88905b
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
2 changes: 1 addition & 1 deletion doc/development/howtos/builders.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ value.
Builder extensions should define an entry point in the ``"sphinx.builders"``
group. The name of the entry point needs to match your builder's
: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
for 'mybuilder' can be defined in the extension's ``pyproject.toml``

Expand Down
8 changes: 5 additions & 3 deletions doc/man/sphinx-build.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Options
the source and output directories, before any other options are passed.
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
a default :ref:`Makefile or Make.bat <makefile_options>`,
Expand Down Expand Up @@ -261,8 +261,10 @@ Options

.. option:: --keep-going

With -W option, keep going processing when getting warnings to the end
of build, and ``sphinx-build`` exits with exit status 1.
Only applicable whilst using :option:`--fail-on-warning`,
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

Expand Down
4 changes: 2 additions & 2 deletions doc/usage/extensions/autodoc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -765,8 +765,8 @@ There are also config values that you can set:

.. confval:: autodoc_warningiserror

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

Expand Down

0 comments on commit b88905b

Please sign in to comment.