astropy / astropy/sphinx-automodapi

Class not documentated properly when it name is not starting with an upper letter

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

Description

Hello,
I just start using autodocapi this morning. It seems that some of my class are correctly populating with methods and attributes... except if the class name don't start with a upper letter. However it is still detected as a class but inside there is no methods and attributes documentation.

Could you help me with that? Do you know a workaround ?
It is an old legacy code used a lot by my lab it will be complicated to change the name of the class just for documentation reason.

Thanks :)
Have a good day

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reproducing the issue in autodocapi with a class whose name does not begin with an uppercase letter, then compare its generated documentation with that of a normally named class. Trace the documentation generation path to find where methods and attributes are omitted; done means the lowercase-named class documents them without requiring a rename.

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
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.