Suggestions for the generated API reference documentation

[Jelmer Vernooij]

Michael Hudson wrote:
> Nicholas Allen wrote:
>> 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.
> 
> How are you finding things?  I generally start at the package root and
> drill down from there, I can see that if you're using one of the indices
> that the test stuff would be a clutter.
> 
>> It would be nice if the API could be generated separately for
>> the Bzr lib API and for the test cases.
> 
> This is certainly possible.
> 
>> The format is also really bad compared to other API generated documents.
> 
> Well hey, _I_ like it, which is no surprise given that I wrote the tool
> that produces it :)

FWIW, I very much prefer the pydoctor output over epydoc, javadoc or
doxygen output. epydoc and javadoc are quite similar, btw.

Cheers,

Jelmer