Die neue Python-Dokumentation

Die neue Python-Dokumentation

Presented at µPy.

A897b36b388796219fe140ad31101ce9?s=128

Marek Kubica

January 24, 2008
Tweet

Transcript

  1. Die neue Python-Dokumentation Marek Kubica 24. Januar 2008

  2. Der aktuelle Stand Umfassende Dokumentation mit L AT EXgeschrieben

  3. Der aktuelle Stand Umfassende Dokumentation mit L AT EXgeschrieben In

    vielen Formaten verfügbar (HTML, PDF, PostScript)
  4. Der aktuelle Stand Umfassende Dokumentation mit L AT EXgeschrieben In

    vielen Formaten verfügbar (HTML, PDF, PostScript) 1620 A4-Seiten PDF
  5. Der aktuelle Stand Umfassende Dokumentation mit L AT EXgeschrieben In

    vielen Formaten verfügbar (HTML, PDF, PostScript) 1620 A4-Seiten PDF (wobei L AT EXmit Papier groÿzügig umgeht)
  6. Der aktuelle Stand Umfassende Dokumentation mit L AT EXgeschrieben In

    vielen Formaten verfügbar (HTML, PDF, PostScript) 1620 A4-Seiten PDF (wobei L AT EXmit Papier groÿzügig umgeht) gröÿtenteils von Guido van Rossum und Fred L. Drake, Jr geschrieben
  7. Der aktuelle Stand Umfassende Dokumentation mit L AT EXgeschrieben In

    vielen Formaten verfügbar (HTML, PDF, PostScript) 1620 A4-Seiten PDF (wobei L AT EXmit Papier groÿzügig umgeht) gröÿtenteils von Guido van Rossum und Fred L. Drake, Jr geschrieben Documentation matters - einer der Gründe warum Python so populär ist.
  8. Besonderheiten Gegenüber Ruby Umfassend (mit Tutorial, Referenz, Embedding-Anleitung, u.v.m.) Keine

    generierte API-Dokumentation
  9. Besonderheiten Gegenüber Ruby Umfassend (mit Tutorial, Referenz, Embedding-Anleitung, u.v.m.) Keine

    generierte API-Dokumentation Englisch ;) Gegenüber Java Mitgeliefert In verschiedenen Formaten verfügbar Einfacher mitzuarbeiten
  10. API-Dokumentation Es gibt auch javadoc-ähnliche Tools für Python pydoc, mitgeliefert

    Epydoc, kann mehr
  11. API-Dokumentation Es gibt auch javadoc-ähnliche Tools für Python pydoc, mitgeliefert

    Epydoc, kann mehr (unter anderem reST) http://epydoc.sourceforge.net/stdlib/
  12. Kritik Am Format L AT EXumständlich zu schreiben - wenig

    Interessenten Umständlich zu generieren - von Fred L. Drake angepasstes LaTeX2HTML keine Suchfunktion (nur über Google-Bot und pyhelp.cgi) http://starship.python.net/crew/theller/pyhelp.cgi Look von 1995 Am Inhalt zu wenige Beispiele keine Möglichkeit für User-Kommentare wie in PHP
  13. Kritik Am Format L AT EXumständlich zu schreiben - wenig

    Interessenten Umständlich zu generieren - von Fred L. Drake angepasstes LaTeX2HTML keine Suchfunktion (nur über Google-Bot und pyhelp.cgi) http://starship.python.net/crew/theller/pyhelp.cgi Look von 1995 Am Inhalt zu wenige Beispiele keine Möglichkeit für User-Kommentare wie in PHP (also nicht Web 2.0-kompatibel) Schlecht verknüpft, Dinge schwer aufzunden
  14. reST als Konkurrent zu L AT EX Was ist das?

    reStructured Text, ein Yet Another Markup-Format Konkurrenz zu Markdown, Textile und wie sie alle heiÿen Als Bestandteil der docutils entstanden Code-Beispiel Code here (highlighted by Pygments)
  15. Was bringt das nun? Say something here