Add 'toctree' option to autosummary directive to generate stub pages #3927
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
seisman
added
maintenance
10 tasks
weiji14
approved these changes
Apr 24, 2025
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.
https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html#directive-option-autosummary-toctree
As the documentation says, the
autosummarydirective needs thetoctreeoption to trigger the generation of stub pages. Currently, theclasstemplate misses thetoctreeoption. That's why the methods in the summary table are not clickable in https://pygmt-dev--3919.org.readthedocs.build/en/3919/api/generated/pygmt.GMTBackendEntrypoint.html (xref PR #3919).This PR fixes the issue and also simplifies
:toctree: ./to:toctree:in other templates.Tested the changes with PR #3919 and it works as expected.