Move documentation to use `sphinx.ext.autodoc` or `sphinx-apidoc`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 751
- Forks
- 324
- Avg merge
- 12h 58m
- Merged PRs (30d)
- 3
Description
Currently, our various classes are described in the documentation via explicit .. class .. method directives. We should move to autodoc, and move these docstrings inline.
This will reduce the duplication, and make it difficult for the documentation to be out-of-sync with the code.
Contributor guide
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 locating the documentation's explicit class and method directives and the corresponding Python classes. Read how the current documentation is organized before assessing the move to sphinx.ext.autodoc or sphinx-apidoc and inline docstrings. Done means the generated documentation comes from the code without duplicated manual descriptions and remains synchronized with it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100