hiveeyes / terkin-datalogger

Datalogger for MicroPython and CPython.
https://terkin.org
GNU Affero General Public License v3.0
60 stars 28 forks source link

Add Sphinx for rendering documentation #74

Closed poesel closed 4 years ago

poesel commented 4 years ago

Anfangskonfiguration für die Dokumentation mit Sphinx https://www.sphinx-doc.org/

Sphinx müsste dann wohl noch in die requirements oder manuell: pip install -U sphinx.

Da ist auch gleich ein Makefile für Unix/Windows dabei. Das sollte dann idealerweise von unserer Make Umgebung aufgerufen werden. Manuell in /doc: 'make html' aufrufen. Das Ergebnis ist dann unter /build.

Es ist noch nicht allzu hübsch oder allzuviel. Die RSTs sind aber alle drin und umal.py hab ich als Beispiel für Python Doku eingefügt.

In den RSTs war ein Tippfehler und es fehlte eine Überschrift. Das hatte Sphinx angemeckert.

amotl commented 4 years ago

Exzellent! Ich wollte das schon seit Tagen/Wochen hinzugefügt haben. Vielen herzlichen Dank.