[Buildbot-devel] API documentation

[Marcus Lindblom]

Thomas Vander Stichele wrote:
> Hi all,
> 
> after a long hiatus I'm trying to get back into the swing of doing some
> buildbot hacking.
> 
> (Maybe this time around I might actually work up the courage to polish
> and finish the praise/blame patch for the irc bot, who knows!)
> 
> On any project that uses Twisted I get lost without good API docs.  I
> guess epydoc had me spoilt.  So my first problem is, it seems the API
> docs aren't actually online at buildbot.net
> 
> Am I missing something obvious ?

Not sure. Dustin/Brian should know more about that (ping! ;). Since 
we're running the metabuildbot on buildbot.net, building and publishing 
API docs ought to be doable.

> Second, there are some problems with the current API doc tags.  I assume
> it makes sense to create a separate git branch for doc fixes, and make
> them as I re-acquaint myself with the API ?

Any improvement is good improvement (I think. ;) and thus always welcome.

You can always ping the maillist with RFC:s on your work, and ask 
someone to pull and merge your changes into the mainline.

Cheers,
/Marcus