Dokumentation

API-Dokumentation mit Epydoc, Zpydoc, DocFinder und doctest.

erstellt von Veit Schiele — zuletzt verändert: 12.04.2009 14:47 Uhr © Veit Schiele 2006–2007

Epydoc: Epydoc generiert API-Dokumentationen für Python-Module, basierend auf deren docstrings. Es zeigt dabei den gesamten Vererbungsbaum an.
Zpydoc: Zpydoc erlaubt die Ansicht des Quellcodes, mit SilverCity und PloneSilverCity wird die Syntax auch farblich hervorgehoben.
DocFinderTab: Dieses Produkt macht DocFinder im ZMI verfügbar. DocFinder analysiert Zope-Objekte, bestimmt die verwendeten Klassen und deren Attribute. Es erlaubt Lesezugriffe auf den Quellcode der Klassen und Methoden.
doctest: doctest erlaubt literate testing und executable documentation.

Tim Peters, Jim Fulton: Literate unit testing: Unit Testing with Doctest: http://www.python.org/pycon/dc2004/papers/4/
Grig Gheorghiu: Agile Documentation with doctest and epydoc: http://agiletesting.blogspot.com/2005/02/agile-documentation-with-doctest-and.html