HTML Doku aus eigenen Modulen generieren

Wenn du dir nicht sicher bist, in welchem der anderen Foren du die Frage stellen sollst, dann bist du hier im Forum für allgemeine Fragen sicher richtig.
ferdi09
User
Beiträge: 16
Registriert: Donnerstag 18. Januar 2007, 11:23

HTML Doku aus eigenen Modulen generieren

Beitragvon ferdi09 » Donnerstag 18. Januar 2007, 11:27

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
BlackJack

Beitragvon BlackJack » Donnerstag 18. Januar 2007, 12:03

Das naheliegenste ist `pydoc`, das ist dabei. Dann gibt es diverse andere Programme wie z.B. `epydoc`, die etwas hübschere HTML-Doku erstellen.
ferdi09
User
Beiträge: 16
Registriert: Donnerstag 18. Januar 2007, 11:23

Beitragvon ferdi09 » Donnerstag 18. Januar 2007, 13:04

Danke das probiere ich mal aus.
sape
User
Beiträge: 1157
Registriert: Sonntag 3. September 2006, 12:52

Beitragvon sape » Freitag 19. Januar 2007, 10:51

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
ferdi09
User
Beiträge: 16
Registriert: Donnerstag 18. Januar 2007, 11:23

Beitragvon ferdi09 » Montag 29. Januar 2007, 11:50

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.
Benutzeravatar
birkenfeld
Python-Forum Veteran
Beiträge: 1603
Registriert: Montag 20. März 2006, 15:29
Wohnort: Die aufstrebende Universitätsstadt bei München

Beitragvon birkenfeld » Montag 29. Januar 2007, 17:16

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.
Dann lieber noch Vim 7 als Windows 7.

http://pythonic.pocoo.org/
Y0Gi
User
Beiträge: 1454
Registriert: Freitag 22. September 2006, 23:05
Wohnort: ja

Beitragvon Y0Gi » Montag 29. Januar 2007, 18:13

Ich mag den Output von pudge.

Wer ist online?

Mitglieder in diesem Forum: de_tom