astropy / astropy/sphinx-automodapi

Question: headings not working

Open
#185 3 comments 0 reactions 0 assignees View on GitHub
question
Dominant language
Python
Stars
67
Forks
48
Avg merge
11h 52m
Merged PRs (30d)
1

Description

Hello.

I'm new to automodapi and i tried to do use your library for my python code:
"""
.. automodapi:: path.to.my.code.with.a.long.name.mycode
:inheritance-diagram:

.. automodapi:: path.to.my.code.with.a.long.name.mysecondcode
:inheritance-diagram:

"""

However my path is so long, it's baldy displayed in my doc. Especialy inside the table of content.

So i tried to use the :headings: option to change the name displayed and avoiding th

"""
.. automodapi:: path.to.my.code.with.a.long.name.mycode
:inheritance-diagram:
:headings: My_Title

.. automodapi:: path.to.my.code.with.a.long.name.mysecondcode
:inheritance-diagram:
:headings: My_second_Title
"""

However it didn't change the title in my table of content, but added a lot of the firsts letters in my titles like this in my page:
"""
automodapi:: path.to.my.code.with.a.long.name.mycode Package MMMMMMMMMMMMMMMMMMMM

Classes
[...]
Class Inheritance Diagram
[...]

path.to.my.code.with.a.long.name.mysecondcode Package YYYYYYYYYYYYYYYYYYYYYYYYYYY

Classes
[...]
Class Inheritance Diagram
[...]

"""

I didn't find any useful ressource except the documentation nor a satisfaying example on the internet.
Could you explain me if it's an issue or if i'm using something wrong ?

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reproducing the two `automodapi` directives from the issue, including `:headings:`, and compare the generated page and table of contents with the documented behavior. Trace the directive's heading option handling and identify whether the displayed titles are produced by the extension or Sphinx. Done means the configured headings appear correctly without the unwanted characters.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.