Comment 1 for bug 325367

Revision history for this message
Markus Korn (thekorn) wrote :

I agree, as more and more methods are added to the API, this api-doc needs a better structure with a TOC and maybe a search-index.

What about using a framework like sphinx [0] for this? This needs a xsl style-sheet to convert the wadl definition to reStructuredText. This stylesheet can also be used to create __doc__ entries for each method, so that e.g. help(launchpad.bugs) prints some useful help text instead of the docstring of all collections-objects.

Markus

[0] http://sphinx.pocoo.org