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

Merge pull request #3931 from tk0miya/3926_autodoc_warningiserror

Browse Source 
Fix #3926: Add ``autodoc_warningiserror`` to suppress the behavior of ``-W`` option
This commit is contained in:
Takeshi KOMIYA
2017-07-16 14:06:38 +09:00
committed by GitHub
parent 1869f4d674 bfd71cd77b
commit 246143dc3a
5 changed files with 71 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
doc/ext/autodoc.rst
View File

@@ -386,6 +386,13 @@ There are also new config values that you can set:
This config value only requires to declare the top-level modules that
should be mocked.
.. confval:: autodoc_warningiserror
This value controls the behavior of :option:`sphinx-build -W` during
importing modules.
If ``False`` is given, autodoc forcely suppresses the error if the imported
module emits warnings. By default, ``True``.
Docstring preprocessing
-----------------------