RTD documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 30/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
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.
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.
- Dominant language
- Python
- Stars
- 19
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
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.
More from labthings/python-labthings
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
labthings/python-labthings#324 ·
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
labthings/python-labthings#323 · 3 comments ·
-
Difficulty 5/5 Over a week Newbie friendliness 15/100
labthings/python-labthings#302 · 2 comments ·
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
labthings/python-labthings#300 ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
labthings/python-labthings#237 · 3 comments ·
All issues in labthings/python-labthings
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
stephrobert/dsoxlab#238 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
sublimehq/package_control#1780 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
nwg-piotr/nwg-displays#145 ·