From af271881e2232d9a2ad3cdb3c89ab951d57110c2 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Wed, 17 Apr 2024 21:23:01 +0100 Subject: [PATCH] Add ``config.cache`` to the list of warning types --- doc/usage/configuration.rst | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/doc/usage/configuration.rst b/doc/usage/configuration.rst index 32dfecc7202..a27107f86cc 100644 --- a/doc/usage/configuration.rst +++ b/doc/usage/configuration.rst @@ -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.`` + * ``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.`` .. versionchanged:: 3.3.0 @@ -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