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

✨ Add show_warning_types configuration variable (#12131)

Browse Source 
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
This commit is contained in:
Chris Sewell
2024-03-19 10:22:28 +01:00
committed by GitHub
parent 3f3d3d8517
commit b0f096f440
6 changed files with 52 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
doc/usage/configuration.rst
View File

@@ -326,11 +326,19 @@ General configuration
.. versionadded:: 0.5
.. confval:: show_warning_types
If ``True``, the type of each warning is added as a suffix to the warning message,
e.g., ``WARNING: [...] [index]`` or ``WARNING: [...] [toc.circular]``.
The default is ``False``.
.. versionadded:: 7.3.0
.. confval:: suppress_warnings
A list of warning types to suppress arbitrary warning messages.
Sphinx supports following warning types:
Sphinx core supports following warning types:
* ``app.add_node``
* ``app.add_directive``
@@ -359,11 +367,11 @@ General configuration
* ``toc.not_readable``
* ``toc.secnum``
Then extensions can also define their own warning types.
You can choose from these types. You can also give only the first
component to exclude all warnings attached to it.
Now, this option should be considered *experimental*.
.. versionadded:: 1.4
.. versionchanged:: 1.5