labthings / labthings/python-labthings
RTD documentation
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 19
- Forks
- 2
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die Sphinx-Dokumentationskonfiguration des Projekts und den von autodocs abgedeckten Code zu lokalisieren. Sieh die Dokumentation des OpenFlexure Microscope auf Inhalte zum Schreiben von Things und Extensions durch und ermittle anschließend, was davon hier zutrifft. Als erledigt gilt die Aufgabe, wenn die relevante Dokumentation für python-labthings generiert oder angepasst wurde und erfolgreich erstellt wird.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 30/100