Fix "document isn't included in any toctree" warning causing CI/CD failure - #571
Merged
Conversation
prerequisites and quickstart/index were listed in two separate toctrees within the same index.rst: a hidden one at the top and a captioned one further down. This caused Sphinx to warn that both documents were 'referenced in multiple toctrees'. Remove the redundant hidden toctree, keeping only the visible captioned one which is already sufficient for navigation. Fixes: 0b043f3 ("ad485x: Enhancements") Signed-off-by: Philip Molloy <philip.molloy@analog.com>
The production_testing/ subdirectory contained complete documentation but was not reachable from any toctree. The toctree in index.rst that would include it was commented out with a note 'Enable after adding new content', despite the content already being present and complete. Uncomment the toctree so that production_testing/index.rst is included in the documentation tree and no longer produces an orphan warning. Fixes: f6233d6 ("solutions:adrd8012-01z: Update to latest state") Signed-off-by: Philip Molloy <philip.molloy@analog.com>
pamolloy
marked this pull request as ready for review
August 11, 2026 00:18
gastmaier
approved these changes
Aug 11, 2026
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.
See latest build on
main: https://github.com/analogdevicesinc/documentation/actions/runs/31424075799/job/93571513156#step:4:67Type
Checklist
make htmloradoc serve: