labthings / labthings/python-labthings
RTD documentation
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 19
- Fork
- 2
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia individuando la configurazione della documentazione Sphinx del progetto e il codice coperto da autodocs. Esamina la documentazione di OpenFlexure Microscope per trovare materiale sulla scrittura di Things e Extensions, quindi identifica ciò che si applica in questo caso. Il lavoro è terminato quando la documentazione pertinente è stata generata o adattata per python-labthings e viene compilata correttamente.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 30/100