readthedocs / readthedocs/sphinx-autoapi
Allow separate documentation for class and `__init__` constructor
Open
Nobody has claimed this yet.
Good First Issue
- Dominant language
- Python
- Stars
- 494
- Forks
- 147
- Avg merge
- 9m
- Merged PRs (30d)
- 1
Description
Context here.
It would be nice to be able to separately document a class and its __init__ constructor.
This could potentially be done by adding an extra option to autoapi_python_class_content, say separate.
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 with the autoapi_python_class_content configuration reference and the context linked in issue #476. Determine how a proposed separate option should distinguish class documentation from __init__ documentation, then verify that the documentation output presents them separately.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100