Consider adding sphinx-autodoc-typehints to requirements.txt
Open
Nobody has claimed this yet.
- Dominant language
- Makefile
- Stars
- 106
- Forks
- 190
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 1
Description
@pauleveritt suggests the use of sphinx-autodoc-typehints to auto-document docstrings and typehints. In addition to the nice formatting, the return type of one class can be hyperlinked to another in the documentation.
See tutorial and updated code samples
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 requirements.txt and checking how documentation dependencies are declared. Confirm that sphinx-autodoc-typehints is included there and that the documentation setup recognizes it; the work is done when the dependency is recorded and the documentation build remains functional.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 42/100