0

I am generating python API documentation using Sphinx and sphinx-apidoc with sphinx-rtd-theme

The problem is:

The page titles and ToC entries for modules/packages always show the full import path, e.g. myproject.subpackage.longname.module

This makes the sidebar and headings extremely long.

What I already solved

Using the following in conf.py:

add_module_names = False

This successfully removes the module prefix from class names.

What I already tried

  1. toc_object_entries_show_parents

toc_object_entries_show_parents = False

Question

Is there a way to configure Sphinx so that module/package titles are short names rather than full import paths?

Improve this question
0
Related questions
1869
How can I import a module dynamically given the full path?
21
Customize templates for `sphinx-apidoc`
16
How to generate Python documentation using Sphinx with zero configuration?
Load 5 more related questions Show fewer related questions

0

Reset to default

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.