Skip to content

Document include-only reStructuredText files - #14649

Open
jdillard wants to merge 2 commits into
sphinx-doc:masterfrom
jdillard:ref-9707
Open

Document include-only reStructuredText files#14649
jdillard wants to merge 2 commits into
sphinx-doc:masterfrom
jdillard:ref-9707

Conversation

@jdillard

Copy link
Copy Markdown
Member

Purpose

Explain that files matching source_suffix are treated as standalone documents, even when used with include and document best practices for creating reusable include-only content using a different suffix or exclude_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.

jdillard and others added 2 commits August 25, 2026 02:01
Corrected wording for clarity regarding file suffixes and inclusion in Sphinx documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant