Document include-only reStructuredText files - #14649
Open
jdillard wants to merge 2 commits into
Open
Conversation
Corrected wording for clarity regarding file suffixes and inclusion in Sphinx documentation.
This file contains hidden or 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
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
Explain that files matching
source_suffixare treated as standalone documents, even when used withincludeand document best practices for creating reusable include-only content using a different suffix orexclude_patterns, preventing duplicate-label warnings.The reactions and related reports indicate that this has been a recurring source of confusion for users, so thought it was worth making an improvement.
References
AI Disclosure
AI was used to investigate the issue and draft the documentation change. I reviewed and validated the text.