Use long options to sphinx-build in our documentation

This commit is contained in:
Adam Turner committed 2024-07-24 15:21:25 +01:00
1 parent fc808e0e90
commit b88905b6f7
3 files changed
+8 -6

No files matched your search

+2 -2
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``.