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 `config.cache` to the list of warning types

Browse Source
This commit is contained in:
Adam Turner 2024-04-17 21:23:01 +01:00
parent be2b08362c
commit af271881e2
1 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/usage/configuration.rst
View File

@ -345,7 +345,7 @@ General configuration
* ``app.add_role``
* ``app.add_generic_role``
* ``app.add_source_parser``
* ``autosectionlabel.*``
* ``config.cache``
* ``download.not_readable``
* ``epub.unknown_project_files``
* ``epub.duplicated_toc_entry``
@ -367,7 +367,14 @@ General configuration
* ``toc.not_readable``
* ``toc.secnum``
Then extensions can also define their own warning types.
Extensions can also define their own warning types.
Those defined by the first-party ``sphinx.ext`` extensions are:
* ``autodoc``
* ``autodoc.import_object``
* ``autosectionlabel.<document name>``
* ``autosummary``
* ``intersphinx.external``
You can choose from these types. You can also give only the first
component to exclude all warnings attached to it.
@ -388,7 +395,7 @@ General configuration
.. versionchanged:: 2.1
Added ``autosectionlabel.*``
Added ``autosectionlabel.<document name>``
.. versionchanged:: 3.3.0
@ -402,9 +409,13 @@ General configuration
Added ``i18n.inconsistent_references``
.. versionadded:: 7.1
.. versionadded:: 7.1
Added ``index`` warning type.
Added ``index`` warning type.
.. versionadded:: 7.3
Added ``config.cache`` warning type.
.. confval:: needs_sphinx