Suggestions for the generated API reference documentation

[Nicholas Allen]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi,

I find using the API reference for the Bazaar API really cumbersome and
time consuming.  This is mainly because it includes all the test code as
well as the actual BzrLib API. This makes finding something much more of
a problem. It would be nice if the API could be generated separately for
the Bzr lib API and for the test cases.

The format is also really bad compared to other API generated documents.
I don't know if this is a problem with the API document generators for
Python or if this can be configured to produce something sane (I hope
so). Something like what JavaDoc produces would be much better.

Improving the generated documentation is especially helpful for
contributors because Python is not a statically typed language and an
IDE cannot offer much help to navigate and get familiar with the code base.

Cheers,

Nick
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iEYEARECAAYFAkmao2wACgkQ1+i51gqqEGk50QCfb7xF/f9LdgTWJgblbsDVf3H1
jRsAn3g5KgQLsIHl1yEo14GzufUQBWSb
=F1My
-----END PGP SIGNATURE-----