Dokumentation der Komponenten direkt aus dem Quelltext?

ewaldshof / ewhome

GNU General Public License v3.0

0 stars 0 forks source link

Dokumentation der Komponenten direkt aus dem Quelltext? #26

Closed sulimma closed 3 years ago

sulimma commented 3 years ago

Gibt es ein Tool, dass Github-Wiki-Seiten aus Kommentaren im Quelltext erzeugt?

sulimma commented 3 years ago

pydoc kann nicht ohne weiteres benutzt werden, da einige Micropython-Module nicht im gewöhnlichen Python verfügbar sind. Das gilt für eine ganze Reihe von Tools, die die Dateien nicht selbst parsen sondern in Python importieren.

sulimma commented 3 years ago

pydoc-markdown könnte gehen, ich habe aber noch nicht gerafft, was ich konfigurieren muss, um überhaupt einen Output zu bekommen.

sulimma commented 3 years ago

Ist den Aufwand nicht wert.