quellcode ordentlich dokumentieren

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.
flyingfish
User
Beiträge: 33
Registriert: Sonntag 23. Januar 2005, 23:36

Mittwoch 23. März 2005, 14:14

ah, irgendwie geht es bei mir jetzt auch, weiss nicht wieso vorher nicht.
Allerdings generiert er auch nur die index datei "project.html". Er gibt dort die darunterliegenden Dateien an, verlinkt sie aber mit project.dateiname.html.
Die existieren jedoch nicht, da er sie nicht generiert hat. Aber ich kann ja in das verzeichnis gehen, die dokumente generieren und ein rename bekomme ich ja noch hin :)

Danke schoen!
Benutzeravatar
jens
Moderator
Beiträge: 8461
Registriert: Dienstag 10. August 2004, 09:40
Wohnort: duisburg
Kontaktdaten:

Mittwoch 27. April 2005, 21:06

Genau das selbe Problem hab ich nun auch...

Es kann doch aber nicht nur so geregelt sein, das man jede Datei einzeln erstellen muß...

OK, man könnte schnell mit os.walk() das erledigen, aber es muß doch auch schon andere auf die Idee gekommen sein...

Die HTML-Ausgaben von pydoc sind ja schon ganz nett. Schöner wäre es allerdings wenn man daraus direkt verlinkt zum Quellencode der jeweiligen Funktionen/Methoden/Klassen hin und her wechseln könnte...

EDIT: Hab das http://www.python.org/moin/DocumentationTools gefunde...

CMS in Python: http://www.pylucid.org
GitHub | Open HUB | Xing | Linked in
Bitcoins to: 1JEgSQepxGjdprNedC9tXQWLpS424AL8cd
Benutzeravatar
jens
Moderator
Beiträge: 8461
Registriert: Dienstag 10. August 2004, 09:40
Wohnort: duisburg
Kontaktdaten:

Donnerstag 28. April 2005, 15:13

epydoc ist ganz nett... Es generiert sowas: http://epydoc.sourceforge.net/api/
Ich würde es allerdings nett finden, wenn man aus den generierten DOC direkt in den Quellencode springen könnte...

Um Quellencode als HTML zu konvertieren, gibt es ein ganz nützlichen Eintrag im Cookbook: http://aspn.activestate.com/ASPN/Cookbo ... cipe/52298

Kennt jemand schon dafür ein fertiges System?

CMS in Python: http://www.pylucid.org
GitHub | Open HUB | Xing | Linked in
Bitcoins to: 1JEgSQepxGjdprNedC9tXQWLpS424AL8cd
Antworten