Consider deploying sphinx for autodocs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 139
- Forks
- 52
- Avg merge
- 1h 16m
- Merged PRs (30d)
- 3
Description
Sphinx provides great utilities for auto-generating docs for code based on docstrings. We should consider utilizing it and publishing our docs using it. Note that to get the most out of it we would need to enforce reST style docstrings on all classes, modules, functions and class/instance attributes.
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 reviewing the project's current documentation, Python docstrings, and documentation publishing setup; no specific files or tests are named in the issue. Determine whether adopting Sphinx and enforcing reST docstrings are both in scope. Done means a defined Sphinx-based autodoc workflow is published and the required docstring conventions are documented or applied.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100