How to remove module and class prefix in TOC names?

[ShawnHymel]

I'm not sure if this is a Sphinx issue or a Furo issue, but I'll start here anyway. There are 2 things going on that I'd like help with:

1. All names in the TOC (left sidebar) are prepended with the package/module name. For example, edgeimpulse_api.api.admin_api module. Is there a way to remove the prefixes so that it just shows admin_api module? As it's underneath the edgeimpulse_api.api package drop-down menu, I figure this would be obvious to users, and it would make for a cleaner TOC in the sidebar.
2. All names in the page TOC (right sidebar) suffer from the same issue. For example, under AdminApi, the methods are listed as e.g. AdminApi.admin_add_disallowed_email_domain(). How do I get rid of all the AdminApi prefixes to just show the method as admin_add_disallowed_email_domain()?

I have tried setting add_module_names = False in conf.py, but that seems to just remove the module/class prefixes from the signature and does not affect anything in the TOC.

[dgw]

For 2, at least, I would check your toc_object_entries_show_parents setting in conf.py. With the default value ("domain"), in a Python project, I'm not seeing excessive prefixes in Furo's right sidebar.

(This might solve 1, too, but our docset is organized manually into pages, so auto-generated page titles based on the module name aren't used anywhere.)

[ShawnHymel]

Hi @dgw,

Thank you! I was looking for hours yesterday, and setting toc_object_entries_show_parents = "hide" did the trick to solve #2.

It did not help with #1. The closest I could find was to go through each .rst file and remove the package/module parents from the title. For example, in edgeimpulse_api.api.admin_api.rst, I changed

edgeimpulse\_api.api.auth\_api module
=====================================

to

auth\_api module
================

That helped make some of the longer titles much easier to read on the left sidebar and on the page itself (see screenshot).

My follow-up question: is there any way to change the title like this automatically (either in sphinx-apidoc or sphinx-build) without needing to manually edit every .rst file? My search has not turned up anything, and my backup plan is to create a pre-processing script that runs between sphinx-apidoc and sphinx-build that modifies the titles in all .rst files (not pretty, so I'm hoping to avoid this option).

[dgw]

sphinx-apidoc can generate conf.py (with --full), but doesn't read it, so I suppose it makes sense that options therein won't affect the command's behavior.

A lot of poking around the documentation and code for sphinx-apidoc has yielded no hints for modifying the names or titles it generates. It doesn't seem to have a ton of knobs you can tweak.

Granted, I've not used that part of Sphinx before, so I could be missing stuff. But it's definitely a sphinx-apidoc question at this point, and not a Furo one. At the very least, you might be better able to find the right IRC channel/discussion board/mailing list/etc. to ask the real question now: "How do I omit the package prefix from sphinx-apidoc page titles?" 😅

[ShawnHymel]

No worries, and that helps a lot, thank you! I found a Sphinx users Google group here, so I'll see if anyone there knows.