Add automatic doc generation for AD transforms
Open
Nobody has claimed this yet.
Doc
- Dominant language
- Python
- Stars
- 14.7k
- Forks
- 2.8k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 489
Description
Documentation enhancement for our transforms:
API docstrings and auto-generated API references in docs
- Sphinx is already set up to take docstrings
- Explore/update it to have documentation for transforms
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 with the existing Sphinx configuration and the transform implementations or docstrings it currently discovers. Trace how API references are generated, then update the documentation setup so transforms appear in the generated references and verify the output includes their API docstrings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100