Skip to content

Commit af27188

Browse files
committed
Add config.cache to the list of warning types
1 parent be2b083 commit af27188

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

doc/usage/configuration.rst

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,7 @@ General configuration
345345
* ``app.add_role``
346346
* ``app.add_generic_role``
347347
* ``app.add_source_parser``
348-
* ``autosectionlabel.*``
348+
* ``config.cache``
349349
* ``download.not_readable``
350350
* ``epub.unknown_project_files``
351351
* ``epub.duplicated_toc_entry``
@@ -367,7 +367,14 @@ General configuration
367367
* ``toc.not_readable``
368368
* ``toc.secnum``
369369

370-
Then extensions can also define their own warning types.
370+
Extensions can also define their own warning types.
371+
Those defined by the first-party ``sphinx.ext`` extensions are:
372+
373+
* ``autodoc``
374+
* ``autodoc.import_object``
375+
* ``autosectionlabel.<document name>``
376+
* ``autosummary``
377+
* ``intersphinx.external``
371378

372379
You can choose from these types. You can also give only the first
373380
component to exclude all warnings attached to it.
@@ -388,7 +395,7 @@ General configuration
388395

389396
.. versionchanged:: 2.1
390397

391-
Added ``autosectionlabel.*``
398+
Added ``autosectionlabel.<document name>``
392399

393400
.. versionchanged:: 3.3.0
394401

@@ -402,9 +409,13 @@ General configuration
402409

403410
Added ``i18n.inconsistent_references``
404411

405-
.. versionadded:: 7.1
412+
.. versionadded:: 7.1
413+
414+
Added ``index`` warning type.
415+
416+
.. versionadded:: 7.3
406417

407-
Added ``index`` warning type.
418+
Added ``config.cache`` warning type.
408419

409420
.. confval:: needs_sphinx
410421

0 commit comments

Comments
 (0)