Allow autosummary
to create pages for classes, functions, etc
#11488
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.
Subject: Allow
autosummary
to create pages for classes, functions, and so onFeature or Bugfix
Purpose
As detailed in #7912 and linked issues,
autosummary
is very useful and with a small tweak is incredibly powerful for generating complete API docs for a project.The solution here is perhaps a little hacky, but it builds on the templates proposed in #7912, with an escape-hatch for projects where this solutions causes more issues. The new option
autosummary_recurse_members
(strawperson name) basically just controls whether:toctree:
is set in the template or not:This new option defaults to
True
so that users get this out of the box -- but this was just my preference.In the class template, the
:inherited-members:
setting is also guarded to respectautodoc_inherit_docstrings
. I'm not sure if the I've implemented this in the correct way, but it does seem to work.Relates