mphowardlab / mphowardlab/relentless
Document everything and build with sphinx
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 13
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Docstrings are needed for pretty much everything, and we want to make sure the docs work. There will also need to be some prose documenting the different design choices, how to extend the code, and some tutorials.
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
The issue names Python docstrings and a Sphinx documentation build, along with design-choice, extension, and tutorial prose, but it does not identify files or entry points. Begin by inventorying the Python modules and existing documentation configuration, then define the documentation scope. Done means the agreed docstrings and prose exist and the Sphinx build succeeds.
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
- 20/100