launchpad-dev team mailing list archive

[Gary Poster <gary.poster@xxxxxxxxxxxxx>]

On Mar 31, 2011, at 8:28 AM, Guilherme Salgado wrote:

> On Thu, 2011-03-31 at 09:28 +0100, Jonathan Lange wrote:
>> On Wed, Mar 30, 2011 at 8:09 PM, Guilherme Salgado
...
>>> I think the apidoc[1] is the best tool we have for this sort of thing as
>>> it leverages our zope component declarations to show a lot of
>>> information about our interfaces/adapters/utilities.
>>> 
>>> [1] https://devpad.canonical.com/~gary
>> 
>> I don't know. I really want to like it, but for some reason it's very
>> hard to. I guess it's partly that we're only running it statically and
>> it relies on AJAX goodness to be at its level best. Perhaps also
>> because it says it's Zope API documentation, and I don't really want
>> to read Zope API documentation. I'm never sure what I would go to that
>> page to learn about, unlike a traditional API documentation
>> (e.g.<http://people.canonical.com/~mwh/canonicalapi/>).
> 
> What I find the most useful thing about it is the interfaces browser,
> which allows you to see all the classes/adapters/utilities that provide
> that interface, the views registered for it and a bunch of other stuff.

Right.  The traditional API documentation simply doesn't have any of the configuration bits around.  For better or worse, huge amounts of Launchpad are connected via configuration-like machinery.

Gary