[Python-de] Re: Python Code in Doku

Achim Domma (Procoders) domma at procoders.net
Mit Okt 27 16:09:48 CEST 2004


Wolfram Kraus wrote:

> Wenn du (X)Emacs (The one true editor) benutzt, kannst du M-x 
> htmlize-buffer probieren. Es gibt noch mehrere htmlize-Funktionen, 
> einfach M-x htmlize-TAB drücken. Damit erzeugst du eine HTML Version des 
> Buffers mit den eingestellten Farben usw. Zur Verwaltung der ganzen Doku 
> würde ich aber dennoch Zope/Plone empfehlen.
> Oder suchst du eher was in die Richtung (e)pydoc ??

Ich stelle mir folgenden Workflow vor:

Ich schreibe ein HTML File zu dem ich ein passendes CSS habe, so daß sie 
sowas in dieser Art einfach 'runterschreiben kann:

<h1>Hauptthema</h1>
<h2>Wie löse ich X mit Klasse Y</h2>
Ein bischen bla bla zu Klasse Y. Und noch
mehr Text. Und dann noch ein bischen Text.
Jetzt kommt ein Beispiel:
<!-- Start Code: subfolder/example1.py -->
<!-- End Code -->
Und noch mehr Text und das nächste Beispiel:
<!-- Start Code: subfolder/example2.py -->
<!-- End Code -->

Dann lasse ich einen Prozessor über das File laufen. Er ersetzt die 
Kommentare durch die als HTML gelayouteten Files und wirft mir 'ne 
statische HTML Seite 'raus, am besten mit eingebettetem CSS, so daß ich 
die einzelne Datei weitergeben kann.

Ich hab' mittlerweile das gnu-Tool source-highlight gefunden. Damit, 
evtl. zusammen mit empy oder so, kann ich mir sicher selbst was 
stricken. Nur hab' ich wenig Lust das Rad neu zu erfinden und dachte, 
daß es sowas eigentlich schon geben muß.

Gruß,
Achim