Sphinx autosummary modules should return module names without path #9743
Labels
extensions:autosummary
help wanted
priority:high
type:enhancement
enhance or introduce a new feature
Milestone
Is your feature request related to a problem? Please describe.
We are using
sphinx.ext.autosummary
with_templates
to create new files for each class, attribute, function.This works perfectly for the above mentioned, where the template file contains (e.g. just for
classes
):Note that we are setting with
.. currentmodule:: {{ fullname }}
the correct path to the current file and then document each class with:{% for class in classes %}
. This works, becauseclasses
returns the class names without prefix (the path contained infullname
).For modules, on the other hand, the approach doesn't work:
The problem is here that
modules
returns a list of modules with the full path.Describe the solution you'd like
Have
modules
return only the module name without prefix (full path)Additional context
We use Sphinx to document our toolbox do-mpc
The text was updated successfully, but these errors were encountered: