Tool für Webdokumentation

Sockets, TCP/IP, (XML-)RPC und ähnliche Themen gehören in dieses Forum
Benutzeravatar
gerold
Python-Forum Veteran
Beiträge: 5554
Registriert: Samstag 28. Februar 2004, 22:04
Wohnort: Telfs (Tirol)
Kontaktdaten:

Tool für Webdokumentation

Beitragvon gerold » Donnerstag 14. September 2006, 16:11

Hallo!

Mit welchem Tool erstellt man so eine Webdokumentation?

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

lg
Gerold
:-)
http://halvar.at | Kleiner Bascom AVR Kurs
Wissen hat eine wunderbare Eigenschaft: Es verdoppelt sich, wenn man es teilt.
JanDMC
User
Beiträge: 95
Registriert: Donnerstag 23. September 2004, 19:35
Kontaktdaten:

Beitragvon JanDMC » Donnerstag 14. September 2006, 16:24

Hey,

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

mfg
joa nää python is toll :D
Benutzeravatar
Leonidas
Administrator
Beiträge: 16023
Registriert: Freitag 20. Juni 2003, 16:30
Kontaktdaten:

Beitragvon Leonidas » Donnerstag 14. September 2006, 17:32

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.
My god, it's full of CARs! | Leonidasvoice vs Modvoice
Benutzeravatar
gerold
Python-Forum Veteran
Beiträge: 5554
Registriert: Samstag 28. Februar 2004, 22:04
Wohnort: Telfs (Tirol)
Kontaktdaten:

Beitragvon gerold » Donnerstag 14. September 2006, 21:40

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

Hi Leonidas!

Schade! :roll: Das hatte ich mir einfacher vorgestellt.

lg
Gerold
:-)
http://halvar.at | Kleiner Bascom AVR Kurs

Wissen hat eine wunderbare Eigenschaft: Es verdoppelt sich, wenn man es teilt.
Benutzeravatar
Rebecca
User
Beiträge: 1662
Registriert: Freitag 3. Februar 2006, 12:28
Wohnort: DN, Heimat: HB
Kontaktdaten:

Beitragvon Rebecca » Freitag 15. September 2006, 08:36

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/
Benutzeravatar
Leonidas
Administrator
Beiträge: 16023
Registriert: Freitag 20. Juni 2003, 16:30
Kontaktdaten:

Beitragvon Leonidas » Samstag 16. September 2006, 13:59

Rebecca hat geschrieben: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.
My god, it's full of CARs! | Leonidasvoice vs Modvoice
BlackJack

Beitragvon BlackJack » Samstag 16. September 2006, 14:20

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.
Benutzeravatar
mitsuhiko
User
Beiträge: 1790
Registriert: Donnerstag 28. Oktober 2004, 16:33
Wohnort: Graz, Steiermark - Österreich
Kontaktdaten:

Re: Tool für Webdokumentation

Beitragvon mitsuhiko » Samstag 16. September 2006, 16:57

gerold hat geschrieben: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.
TUFKAB – the user formerly known as blackbird
Benutzeravatar
Mr_Snede
User
Beiträge: 387
Registriert: Sonntag 8. Februar 2004, 16:02
Wohnort: D-Dorf, Bo

Beitragvon Mr_Snede » Sonntag 17. September 2006, 03:00

Vielleicht helfen dir
- rest2web
- txt2tags
weiler.
Benutzeravatar
gerold
Python-Forum Veteran
Beiträge: 5554
Registriert: Samstag 28. Februar 2004, 22:04
Wohnort: Telfs (Tirol)
Kontaktdaten:

Beitragvon gerold » Sonntag 17. September 2006, 09:08

Hi!

Vielen Dank für die vielen Anregungen!

lg
Gerold
:-)
http://halvar.at | Kleiner Bascom AVR Kurs

Wissen hat eine wunderbare Eigenschaft: Es verdoppelt sich, wenn man es teilt.

Wer ist online?

Mitglieder in diesem Forum: 0 Mitglieder