GEOPY-2456: Solve warning issues raised by RTD#899
Open
MatthieuCMira wants to merge 1 commit into
Open
Conversation
github-actions
Bot
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
Adds missing Sphinx toctree directives to key documentation index pages so ReadTheDocs/Sphinx includes the relevant sections and stops emitting “not in any toctree/orphan” style warnings.
Changes:
- Added a top-level
toctreetodocs/index.rstto explicitly include major documentation sections. - Added section-level
toctreeblocks to the UI.JSON format docs and GEOH5 format docs (including the Integrator subsection). - Wired Integrator subsection pages (
data,groups,objects,themes) into its index.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/index.rst | Adds a root toctree listing primary documentation entry points. |
| docs/content/uijson_format/index.rst | Adds a toctree to include UI.JSON subpages. |
| docs/content/geoh5_format/index.rst | Adds a toctree to include GEOH5 format chapters and Integrator index. |
| docs/content/geoh5_format/integrator/index.rst | Adds a toctree to include Integrator subsection pages. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
Author
|
The warnings seems to come from the api autobuild. |
domfournier
requested changes
May 25, 2026
Contributor
domfournier
left a comment
domfournier
left a comment
There was a problem hiding this comment.
Those changes are not solving any of the RTD warnings, and also duplicating the list of entries... revert changes
Comment on lines
+25
to
+31
| workspace | ||
| groups | ||
| objects | ||
| data | ||
| types | ||
| giftools | ||
| integrator/index |
Contributor
There was a problem hiding this comment.
THis making the TOC to duplicate the list
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.
GEOPY-2456 - Solve warning issues raised by RTD
add toctree to remove local warnings