Skip to content

Fix "document isn't included in any toctree" warning causing CI/CD failure - #571

Merged
gastmaier merged 2 commits into
mainfrom
solutions/reference-design
Aug 11, 2026
Merged

Fix "document isn't included in any toctree" warning causing CI/CD failure#571
gastmaier merged 2 commits into
mainfrom
solutions/reference-design

Conversation

@pamolloy

@pamolloy pamolloy commented Aug 11, 2026

Copy link
Copy Markdown
Collaborator

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
pamolloy requested a review from gastmaier August 11, 2026 00:16
@pamolloy pamolloy changed the title Solutions/reference design Fix "document isn't included in any toctree" warning causing CI/CD failure Aug 11, 2026
@pamolloy
pamolloy marked this pull request as ready for review August 11, 2026 00:18
@pamolloy pamolloy self-assigned this Aug 11, 2026
@pamolloy
pamolloy requested review from StancaPop and alin724 August 11, 2026 00:28
@gastmaier
gastmaier merged commit 3cacf8e into main Aug 11, 2026
3 checks passed
@gastmaier
gastmaier deleted the solutions/reference-design branch August 11, 2026 04:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants