RTD documentation

Offen

#5 erstellt am 07.2.2020 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 4/5
Geschätzter Aufwand: 3-5 Tage
Anfängerfreundlichkeit: 30/100

Issue-Typ: Dokumentation
Klarheit: Muss geklärt werden
Aktivitätsstatus: Veraltet
Tech-Stack: python
Bereich: documentation

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.

Beschreibung

critical documentation in progress

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.

Vorherrschende Sprache: Python
Sterne: 19
Forks: 2
PR-Merge-Kennzahlen: Keine gemergten PRs in 30 T.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus labthings/python-labthings

Action schema defines links inconsistently with Thing Description Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100

labthings/python-labthings#324 · Erstellt am 10.8.2023
Updating dependencies... Offen

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 20/100

labthings/python-labthings#323 · 3 Kommentare · Erstellt am 15.3.2023
Off-topic: OpenAPI/Swagger Compiler for Server Stubs (ESP32) ? Offen

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 15/100

labthings/python-labthings#302 · 2 Kommentare · Erstellt am 06.12.2021
Changing `ActionView._deque.maxlen` in subclasses Offen

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 30/100

labthings/python-labthings#300 · Erstellt am 26.11.2021
revisiting decorators for actions/properties/etc. Offen

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100

labthings/python-labthings#237 · 3 Kommentare · Erstellt am 30.6.2021

Alle Issues in labthings/python-labthings