File tree 3 files changed +8
-6
lines changed
3 files changed +8
-6
lines changed Original file line number Diff line number Diff line change 13
13
Builder extensions should define an entry point in the ``"sphinx.builders" ``
14
14
group. The name of the entry point needs to match your builder's
15
15
: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
17
17
dotted name of the extension module. Here is an example of how an entry point
18
18
for 'mybuilder' can be defined in the extension's ``pyproject.toml ``
19
19
Original file line number Diff line number Diff line change @@ -43,7 +43,7 @@ Options
43
43
the source and output directories, before any other options are passed.
44
44
For example::
45
45
46
- sphinx-build -M html ./source ./build -W --keep-going
46
+ sphinx-build -M html ./source ./build --fail-on-warning --keep-going
47
47
48
48
The *make-mode * provides the same build functionality as
49
49
a default :ref: `Makefile or Make.bat <makefile_options >`,
@@ -261,8 +261,10 @@ Options
261
261
262
262
.. option :: --keep-going
263
263
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.
266
268
267
269
.. versionadded :: 1.8
268
270
Original file line number Diff line number Diff line change @@ -765,8 +765,8 @@ There are also config values that you can set:
765
765
766
766
.. confval :: autodoc_warningiserror
767
767
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.
770
770
If ``False `` is given, autodoc forcedly suppresses the error if the imported
771
771
module emits warnings. By default, ``True ``.
772
772
You can’t perform that action at this time.
0 commit comments