epydoc reST vs. Epytext

apollo13 · Sonntag 1. April 2007, 12:15

Nun, wie der Titel schon sagt würde mich interessierenwo die großen Unterschiede zwischen Epytext und ReST liegen und was mehr benutzt wird.

Thx, apollo13

Leonidas · Sonntag 1. April 2007, 13:58

apollo13 hat geschrieben:was mehr benutzt wird.

reST, weil es nicht an EPyDoc gebunden ist. Zum Beispiel die Django-Dokumentation wird aus reST generiert, die Python.org-Seite, die pocoo.org-Seite, die Dokumentation von DrPython...

EnTeQuAk · Sonntag 1. April 2007, 14:17

*hust*

Die API-Dokumentation von daucms (siehe Signatur) auch

Ansonsten finde ich persönlich rest einfach schicker...

EpyText ist jedoch ein wenig überschauberer (meine Meinung)

gerold · Sonntag 1. April 2007, 17:43

apollo13 hat geschrieben:Epytext und ReST

Hi apollo13!

Ich verwende reStructuredText. Damit schreibe ich auch die Programmhilfe und lasse mir daraus HTML-Seiten generieren.

mfg
Gerold

apollo13 · Sonntag 1. April 2007, 19:49

Gut, überzeugt

Ich werd mir reSt mal anschaun

oliver1974 · Montag 2. April 2007, 09:27

Hmm, irgendwie finde ich im Netz keine gute reSt Doku, oder besser
gesagt, keine explizite für reSt als Python-Quellcode Doku?

Gibts da was brauchbares? So den richtigen Durchbruch habe ich da nämlich noch nie gefunden, aber reSt hört sich ja nett an.

birkenfeld · Montag 2. April 2007, 10:37

Was genau fehlt dir? ReST ist auf http://docutils.sf.net/rst.html beschrieben. Wie man ReSt mit Epydoc einsetzt, auf http://epydoc.sf.net/manual-othermarkup.html...

oliver1974 · Dienstag 3. April 2007, 06:50

Ganz einfach, der 2. Link war für mich irgendwie erhellender...

Wobei der von Dir genannte Link tot war, folgender geht (momentan):

http://epydoc.sourceforge.net/manual-othermarkup.html

Danke soweit, das sieht recht gut aus..

Wie ist da eigentlich die Situation momentan, was Python und Dokumentation angeht... Da hat man jetzt die Qual der Wahl, oder?

Ich meine, in Java machte man sich irgendwie in der Regel wenig Gedanken, in Python steht man ja geradezu vor einer großen Auswahl...

Ist ja auf der einen Seite schön, aber irgendwie hat das natürlich auch Nachteile. Wenn man fremden Quellcode in sein eigenes Projekt integriert, dann ist ja die Wahrscheinlichkeit recht hoch, dass der mit einer ganz anderen Sprache/System dokumentiert ist als der eigene.. Okay, das ist wahrscheinlich bei vielen anderen Projekten in anderen Sprachen auch so, aber in Java war halt immer ein "Quasi-Standard" üblich....

Leonidas · Dienstag 3. April 2007, 07:21

oliver1974 hat geschrieben:Wobei der von Dir genannte Link tot war

Ist er eigentlich nicht, nur stuft phpBB die nachfolgenden drei Punkte als Teil der URL ein. Wenn du sie wegmachst, kommst du auf den gleichen den du genutzt hast.

Achja, reST *ist* eigentlich ein Quasi-Standard. Zwar nicht gar so Quasi wie Javadoc, aber nichtsdestotrotz.

oliver1974 · Dienstag 3. April 2007, 07:47

Leonidas hat geschrieben:
oliver1974 hat geschrieben:Wobei der von Dir genannte Link tot war
Ist er eigentlich nicht, nur stuft phpBB die nachfolgenden drei Punkte als Teil der URL ein. Wenn du sie wegmachst, kommst du auf den gleichen den du genutzt hast.

Ah ja, Sorry. Konnte ja nicht ahnen dass einem da phpBB ins Gesicht spring....

Achja, reST *ist* eigentlich ein Quasi-Standard. Zwar nicht gar so Quasi wie Javadoc, aber nichtsdestotrotz.

Gut zu wissen, ich frage mich dass nämlich schon seit einiger Zeit.....