[IAEP] Alpha API Docs are up.

David Farning dfarning at gmail.com
Sun Jun 8 17:17:12 CEST 2008

A very early alpha of the API documentation is now up at
http://www.sugarlabs.org/~dfarning/ .

The API are generated using epydoc which has a number of pros and cons.

  Uses standard python docstrings- there is no commitment to epydoc in
the future.
  Very easy.
  Docstrings can be extended using epytext, reStructuredText and

  The parser is more strict than the standard python parser.  It catches
some formatting errors that the python interrupter is able to handles.
In many files the parser stopped before it reached the end of the file.
I will put up a log file so developers can see what errors it is

  Epydoc only documents python files.  I haven't looked to deeply into
the code but it looks like there are several c files in sugar-base and
sugar-toolkit.  Do we want those documented?


More information about the Its.an.education.project mailing list