Allow suppressing a warning of non-matching glob pattern in TOC #13230
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AA-Turner
added
type:enhancement
AA-Turner
reviewed
Jan 10, 2025
AUTHORS.rst
Outdated
| @@ -106,6 +106,7 @@ Contributors | |||
| * Vince Salvino -- JavaScript search improvements | |||
| * Will Maier -- directory HTML builder | |||
| * Zac Hatfield-Dodds -- doctest reporting improvements, intersphinx performance | |||
| * Slawek Figiel -- additional warning suppression | |||
There was a problem hiding this comment.
Please sort your name alphabetically in the list
CHANGES.rst
Outdated
Comment on lines
39
to
40
| * Add a subtype ``toc.glob_not_matching`` to a warning of a non-matching glob | ||
| pattern in TOC. |
There was a problem hiding this comment.
Describe why the change is being made, rather than what it does
Suggested change
| * Add a subtype ``toc.glob_not_matching`` to a 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. |
There was a problem hiding this comment.
Sure, I've rephrased the sentence a bit.
doc/usage/configuration.rst
Outdated
| @@ -1397,6 +1397,7 @@ Options for warning control | |||
| * ``toc.no_title`` | |||
| * ``toc.not_readable`` | |||
| * ``toc.secnum`` | |||
| * ``toc.glob_not_matching`` | |||
There was a problem hiding this comment.
Perhaps?
Suggested change
| * ``toc.glob_not_matching`` | |
| * ``toc.empty_glob`` |
There was a problem hiding this comment.
Okay, I've applied your suggestion.
doc/usage/configuration.rst
Outdated
Comment on lines
1450
to
1452
| .. versionadded:: 8.2 | ||
| Added ``duplicate_declaration.c`` and ``duplicate_declaration.cpp``. | ||
|
|
||
| Added ``duplicate_declaration.c`` and ``duplicate_declaration.cpp``, and | ||
| ``toc.glob_not_matching``. |
There was a problem hiding this comment.
Please split this into a new versionadded directive
|
I've rebased it on the current master. |
AA-Turner
reviewed
Jan 16, 2025
AA-Turner
reviewed
Jan 16, 2025
AA-Turner
approved these changes
Jan 16, 2025
|
Thank you! A |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
Some documentation files are created dynamically in my project. They are included in TOC by the glob pattern. The number of included files varies and may be zero.
I have enabled the
--fail-on-warningthat I found very helpful in improving the quality of my documentation. However, it interrupts the documentation build when the glob pattern matches no entries in any TOC, which is not an error in my project.Unfortunately, the related warning has no subtype specified, and it cannot be suppressed using the
suppress_warningslist.References
No references. I haven't created an issue.