Address review comments

sphinx-doc · Jan 10, 2025 · 32aa1dd · 32aa1dd
1 parent ae344eb
commit 32aa1dd
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 7 deletions.
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -96,6 +96,7 @@ Contributors
 * \A. Rafey Khan -- improved intersphinx typing
 * Roland Meister -- epub builder
 * Sebastian Wiesner -- image handling, distutils support
+* Slawek Figiel -- additional warning suppression
 * Stefan Seefeld -- toctree improvements
 * Stefan van der Walt -- autosummary extension
 * \T. Powers -- HTML output improvements
@@ -106,7 +107,6 @@ Contributors
 * Vince Salvino -- JavaScript search improvements
 * Will Maier -- directory HTML builder
 * Zac Hatfield-Dodds -- doctest reporting improvements, intersphinx performance
-* Slawek Figiel -- additional warning suppression
 
 Former maintainers
 ==================

diff --git a/CHANGES.rst b/CHANGES.rst
@@ -36,8 +36,8 @@ Features added
 * #13146: Napoleon: Unify the type preprocessing logic to allow
   Google-style docstrings to use the optional and default keywords.
   Patch by Chris Barrick.
-* Add a subtype ``toc.glob_not_matching`` to a warning of a non-matching glob
-  pattern in TOC.
+* Add the subtype ``toc.empty_glob`` to allow suppressing the warning of
+  a non-matching glob pattern in TOC.
 
 Bugs fixed
 ----------

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

diff --git a/sphinx/directives/other.py b/sphinx/directives/other.py
@@ -122,7 +122,7 @@ def parse_content(self, toctree: addnodes.toctree) -> None:
                         __("toctree glob pattern %r didn't match any documents"),
                         entry,
                         location=toctree,
-                        subtype='glob_not_matching',
+                        subtype='empty_glob',
                     )
 
                 for docname in doc_names: