Skip to content

Commit

Permalink
Add config.cache to the list of warning types
Browse files Browse the repository at this point in the history
  • Loading branch information
AA-Turner committed Apr 17, 2024
1 parent be2b083 commit af27188
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions doc/usage/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``
Expand All @@ -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.
Expand All @@ -388,7 +395,7 @@ General configuration

.. versionchanged:: 2.1

Added ``autosectionlabel.*``
Added ``autosectionlabel.<document name>``

.. versionchanged:: 3.3.0

Expand All @@ -402,9 +409,13 @@ General configuration

Added ``i18n.inconsistent_references``

.. versionadded:: 7.1
.. versionadded:: 7.1

Added ``index`` warning type.

.. versionadded:: 7.3

Added ``index`` warning type.
Added ``config.cache`` warning type.

.. confval:: needs_sphinx

Expand Down

0 comments on commit af27188

Please sign in to comment.