review

sphinx-doc · Jan 16, 2025 · 8f5cb89 · 8f5cb89
1 parent d16ea85
commit 8f5cb89
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -46,8 +46,9 @@ Features added
   Patch by Adam Turner.
 * #13065: Enable colour by default in when running on CI.
   Patch by Adam Turner.
-* Add the subtype ``toc.empty_glob`` to allow suppressing the warning of
-  a non-matching glob pattern in TOC.
+* Allow supressing warnings from the :rst:dir`toctree` directive when a glob pattern
+  doesn't match any documents, via the new ``toc.glob_not_matching`` warning sub-type.
+  Patch by Slawek Figiel.
 
 Bugs fixed
 ----------

diff --git a/doc/usage/configuration.rst b/doc/usage/configuration.rst
@@ -1393,11 +1393,11 @@ Options for warning control
    * ``misc.copy_overwrite``
    * ``misc.highlighting_failure``
    * ``toc.circular``
+   * ``toc.empty_glob``
    * ``toc.excluded``
    * ``toc.no_title``
    * ``toc.not_readable``
    * ``toc.secnum``
-   * ``toc.empty_glob``
 
    Extensions can also define their own warning types.
    Those defined by the first-party ``sphinx.ext`` extensions are:
@@ -1448,7 +1448,7 @@ Options for warning control
       Added ``misc.copy_overwrite``.
 
    .. versionadded:: 8.2
-      Added ``duplicate_declaration.c`` and ``duplicate_declaration.cpp``
+      Added ``duplicate_declaration.c`` and ``duplicate_declaration.cpp``.
 
    .. versionadded:: 8.2
       Added ``toc.empty_glob``.