IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Use long options to sphinx-build in our documentation

Browse Source
This commit is contained in:
Adam Turner
2024-07-24 15:14:54 +01:00
parent fc808e0e90
commit b88905b6f7
3 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/usage/extensions/autodoc.rst
View File

@@ -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``.