[Buildbot-devel] scheduler.Dependent HOWTO

[Stefan Seefeld]

Brian Warner wrote:
>>Huh, I'm sorry I didn't spot that myself. That's exactly what I was
>>looking for (though I wouldn't mind some API - based reference manual
>>documenting all the public methods etc. ;-).
> 
> 
> That's a good idea.. I'll see if I can put a copy of the epydoc-generated API
> reference on the web site after the new release I'm working on today.

Excellent !

> In general, I've put "how-to" documentation in the (texinfo) User's Manual,
> and specific reference information on the various classes and APIs in the
> (epydoc) docstrings. The User's Manual references the docstrings, but I don't
> yet know how to make the generated HTML use working hyperlinks for those
> references.

Ah, well, if you would use docbook I could be of some help. <wink/>
I'v given up using texinfo a long time ago...

> Having the API docs live in a stable, world-readable place on the
> buildbot web site will be a good first step.

Definitely, and it will make it easier to spot the places that need
clarification.

Thanks,
		Stefan