Hallo,
ich habe ein paar selbstgeschreibene Module und möchte gerne aus dem was man in python bekommt wenn man help(myModule) eintippt eine HTML Seite generieren. Gibt es dafür ein Tool oder einen einfachen Weg.
Mfg
Holger
HTML Doku aus eigenen Modulen generieren
-
BlackJack
Das naheliegenste ist `pydoc`, das ist dabei. Dann gibt es diverse andere Programme wie z.B. `epydoc`, die etwas hübschere HTML-Doku erstellen.
Nimm Epydoc. Das erzeugt XHTML Konforme Dateien. Außerdem erzeugt es automatisch so was: http://epydoc.sourceforge.net/api/ Hat den vorteil das man sich zu einer Methode dann auch den Sourcecode anzeigen lassen kann.
Der Output von Epidoc sieht so aus: http://epydoc.sourceforge.net/api/
Das aussehen lässt sich zusätzlich geringfügig mit CSS-Dateien anpassen.
Bestes Beispiel die API-Doc von Pocoo: http://api.pocoo.org/pocoo.application-module.html
Zusätzlich versteht Epidoc reStructuredText. Hier ist alles was man wissen muss über reStr: http://docutils.sourceforge.net/docs/us ... ckref.html Würde ich empfehlen damit die Docstrings zu schreiben.
BTW: Pydoc würde ich nicht verwenden. Das ist der letzte Schund. Kann nicht mit umlauten umgehen, kein XHTML Konformer Output, etc...
lg
Der Output von Epidoc sieht so aus: http://epydoc.sourceforge.net/api/
Das aussehen lässt sich zusätzlich geringfügig mit CSS-Dateien anpassen.
Bestes Beispiel die API-Doc von Pocoo: http://api.pocoo.org/pocoo.application-module.html
Zusätzlich versteht Epidoc reStructuredText. Hier ist alles was man wissen muss über reStr: http://docutils.sourceforge.net/docs/us ... ckref.html Würde ich empfehlen damit die Docstrings zu schreiben.
BTW: Pydoc würde ich nicht verwenden. Das ist der letzte Schund. Kann nicht mit umlauten umgehen, kein XHTML Konformer Output, etc...
lg
Danke auch für diesen Tip. epidoc werde ich mir auch anschauen.
Gibt es eigentlich auch eine Möglichkeit, aus einem Module die Documentation im Wikipedia Stil zu generieren? Also, so das man hinterher diese in einer Wikipedia Seite einfügen kann inklusive Formatierung.
Gibt es eigentlich auch eine Möglichkeit, aus einem Module die Documentation im Wikipedia Stil zu generieren? Also, so das man hinterher diese in einer Wikipedia Seite einfügen kann inklusive Formatierung.
-
birkenfeld
- Python-Forum Veteran
- Beiträge: 1603
- Registriert: Montag 20. März 2006, 15:29
- Wohnort: Die aufstrebende Universitätsstadt bei München
Da ist mit nichts bekannt.
Aber was würde das bringen? Die Doku wird ja aus den Modulen generiert. Wenn du jetzt im Wiki etwas daran änderst, geht das das nächste Mal verloren, wenn du wieder generierst.
Aber was würde das bringen? Die Doku wird ja aus den Modulen generiert. Wenn du jetzt im Wiki etwas daran änderst, geht das das nächste Mal verloren, wenn du wieder generierst.