[TASK] Issue warning if a document is not included in any toctree #846
Conversation
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
linawolf
force-pushed
the
feature/toctree-warning
branch
from
1828a9f to
6db5c1b
Compare
Markdown does not have a toctree concept. However rst requires all non-orphan documents to be in a toctree
Sphinx also issues this kind of warning. Project who do not desire the warning could deactivate the pass resolves TYPO3-Documentation/render-guides#332
linawolf
force-pushed
the
feature/toctree-warning
branch
from
6db5c1b to
7d7ae5b
Compare
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.
Sphinx also issues this kind of warning. Project who do not
desire the warning could deactivate the pass
resolves TYPO3-Documentation/render-guides#332