Remove package and module name from sphinx function

user_2489206 0
Viewed 7147

it's any way to remove the package and or module name from sphinx doc?

Example: if exist a function called waa inside the module foo.bar, the rst code

.. automodule:: foo.bar
    :members:

will generate

foo.bar.waa()

and i want to output

waa()
python-sphinx
2 Answers

I have a package with submodules and I wanted to still display the submodule name in navigation, as there are multiple duplicate function names across submodules.

For

foo.bar.baz()

I need to display

bar.baz()

This makes

  • Navigation is easier as everything does not start with the same letter from the package name

  • Shorter names are more readable without repeating

For this, I created a custom Jinja filter and then modified autosummary's core templates to use it. The filter is injected through a monkey-patch in Sphinx's conf.py.

An example conf.py:

# Monkey-patch autosummary template context
from sphinx.ext.autosummary.generate import AutosummaryRenderer


def smart_fullname(fullname):
    parts = fullname.split(".")
    return ".".join(parts[1:])


def fixed_init(self, app, template_dir=None):
    AutosummaryRenderer.__old_init__(self, app, template_dir)
    self.env.filters["smart_fullname"] = smart_fullname


AutosummaryRenderer.__old_init__ = AutosummaryRenderer.__init__
AutosummaryRenderer.__init__ = fixed_init

Then here is the example from _templates/autosummary/module.rst:

{{ fullname | smart_fullname | escape | underline}}

Documentation for `{{ fullname }}` module.

.. automodule:: {{ fullname }}

See the full documentation for further examples.

user_3151680
Related