Tool für Webdokumentation

[gerold]

Hallo!

Mit welchem Tool erstellt man so eine Webdokumentation?

http://www.pythonweb.org/projects/snake ... .5.2/html/

lg
Gerold

[JanDMC]

Hey,

Ich weiss es nich genau aber die Farb - und Schriftwahl sieht ähnlich wie EPYDOC aus...

mfg

[Leonidas]

Unten steht "This document was generated using the tools distributed with Python 2.3", also vermute ich mal, dass die das in LaTeX geschrieben haben und dann HTML generiert haben, so wie es eben auch für die Python-Dokumentation üblich ist.

[gerold]

also vermute ich mal, dass die das in LaTeX geschrieben haben und dann HTML generiert haben

Hi Leonidas!

Schade! Das hatte ich mir einfacher vorgestellt.

lg
Gerold

[Rebecca]

Die Doku sieht ja fast genauso aus wie die Python-Doku. Die Python-Doku wurde mit einer stark abgeaenderten Version von latex2html gemacht. latex2html finde ich klasse, da ich LaTeX mag und man ohne Mehraufwand ps/pdf und html-Format bekommt. Es wird aber, glaube ich, nicht mehr gewartet.

Was man auch sehr haeufig sieht, und was so aehnlich aussieht, ist docbook. Da schreibt man seinen Kram in xml und kann ihn dann in diverse Formate ueberfuehren. Es wird zum Beispiel von Blender benutzt:
http://download.blender.org/documentation/htmlI/

[Leonidas]

Was man auch sehr haeufig sieht, und was so aehnlich aussieht, ist docbook. Da schreibt man seinen Kram in xml und kann ihn dann in diverse Formate ueberfuehren.

Ich persönlich mag Docbook nicht, aufgrund dessen irgendwie sehr großen Komplexizität: DSSSL, XML-FO, XSLT und noch zig weitere Möglichkeiten von Docbook machen es ziemlich unpythonic (soweit ich weiß nutzten die Leute bei OReilly Docbook für ihre Bücher). Dafür verwende ich lieber reST, weil es einfacher zu transformieren ist, einfacher den Quellcode zu lesen und auch einfacher den Quellcode zu schreiben ist. Aber was erzähle ich, reST kennt ihr ja sowieso
Für reST könnt man aber versuchen ein Stylesheet zu schrieben, dass die generierten Seiten so aussehen wie die von Pythons latex2html.

[BlackJack]

DocBook hat den Vorteil, das es automatisch generiert und bearbeitet werden kann und Elemente besitzt, die man für API Doku gut gebrauchen kann.

Und die ganzen Arten aus DocBook etwas anderes zu machen, sind ja nicht in der DocBook-Spezifikation selbst festgelegt. Eine ordentliche, einfache Toolchain ist eigentlich bei jeder Linux-Distri schnell installiert. Die XSLT Stylesheets von Norman Walsh kann man notfalls auch manuell installieren.

Schönes Beispiel für DocBook im Einsatz ist Dive Into Python.

[mitsuhiko]

Mit welchem Tool erstellt man so eine Webdokumentation?

Das ist wie angemerkt latex2html. Wenn du eine API Dokumentation willst schau dir mal epydoc3 an. Die Pocoo API wird beispielsweise von dem generiert. In Kombination mit rst für die Docstrings bekommt man auch sehr schön Formattierungen hin. Und damit ist die Dokumentation leichter zu warten, weil wenn man was verändert kann man ganz einfach auch den Docstring anpassen.

[Mr_Snede]

Vielleicht helfen dir
- rest2web
- txt2tags
weiler.

[gerold]

Hi!

Vielen Dank für die vielen Anregungen!

lg
Gerold