readthedocs / readthedocs/sphinx-autoapi
Remove Attributes + classes show no description
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 494
- Forks
- 147
- Avg merge
- 9m
- Merged PRs (30d)
- 1
Description
My documentation can be found here https://asteca.readthedocs.io/en/latest/autoapi/asteca/index.html
I have two issues:
- I'd like to remove the 'Attributes' section entirely as it is just duplicated info from 'Submodules'
- Classes descriptions randomly do not show (some builds it will, some it won't)
Can this be done? Thank you!
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the generated AutoAPI page at the linked Read the Docs URL and compare builds where class descriptions appear or disappear. Investigate the Sphinx AutoAPI documentation-generation path for the duplicated Attributes section and missing descriptions; done means both requested documentation behaviors are consistent and verified in a generated build.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100