labthings / labthings/python-labthings
RTD documentation
Open
Nobody has claimed this yet.
critical
documentation
in progress
- Dominant language
- Python
- Stars
- 19
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
A lot of stuff can be generated using Sphinx autodocs.
A lot of the documentation around writing Things and Extensions can be taken from the OpenFlexure Microscope docs with little change.
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 locating the project's Sphinx documentation configuration and the code covered by autodocs. Review the OpenFlexure Microscope documentation for material about writing Things and Extensions, then identify what applies here. Done means the relevant documentation is generated or adapted for python-labthings and builds successfully.
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
- Needs clarification
- Newbie friendliness
- 30/100