epydoc reST vs. Epytext

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.
Antworten
apollo13
User
Beiträge: 827
Registriert: Samstag 5. Februar 2005, 17:53

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

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...
My god, it's full of CARs! | Leonidasvoice vs Modvoice
EnTeQuAk
User
Beiträge: 986
Registriert: Freitag 21. Juli 2006, 15:03
Wohnort: Berlin
Kontaktdaten:

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)
Benutzeravatar
gerold
Python-Forum Veteran
Beiträge: 5554
Registriert: Samstag 28. Februar 2004, 22:04
Wohnort: Telfs (Tirol)
Kontaktdaten:

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
:-)
[url]http://halvar.at[/url] | [url=http://halvar.at/elektronik/kleiner_bascom_avr_kurs/]Kleiner Bascom AVR Kurs[/url]
Wissen hat eine wunderbare Eigenschaft: Es verdoppelt sich, wenn man es teilt.
apollo13
User
Beiträge: 827
Registriert: Samstag 5. Februar 2005, 17:53

Sonntag 1. April 2007, 19:49

Gut, überzeugt :)
Ich werd mir reSt mal anschaun
oliver1974
User
Beiträge: 97
Registriert: Donnerstag 26. Oktober 2006, 15:01

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.
Benutzeravatar
birkenfeld
Python-Forum Veteran
Beiträge: 1603
Registriert: Montag 20. März 2006, 15:29
Wohnort: Die aufstrebende Universitätsstadt bei München

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...
Dann lieber noch Vim 7 als Windows 7.

http://pythonic.pocoo.org/
oliver1974
User
Beiträge: 97
Registriert: Donnerstag 26. Oktober 2006, 15:01

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

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.
My god, it's full of CARs! | Leonidasvoice vs Modvoice
oliver1974
User
Beiträge: 97
Registriert: Donnerstag 26. Oktober 2006, 15:01

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.....
Antworten