[Tutor] Code documentation

Carlos Daniel Ruvalcaba Valenzuela clsdaniel at gmail.com
Wed Mar 4 06:08:10 CET 2009

Hello list,

I have been coding in python a short while and I have been wondering
which approach should I take on documentation (API docs) for a python
library I have been working on, there is currently code docstrings,
docstrings with some markup (epydoc, etc), or external programs such
as Sphinx (reStructuredText markup).

In your experience which way is the best or what
advantages/disadvantages do you see (experienced) with each approach
that you are familiar.


More information about the Tutor mailing list