[Buildbot-devel] Documentation (was: WebStatus ponderings)

Marcus Lindblom macke at yar.nu
Thu Jan 7 20:36:35 UTC 2010


On 2010-01-07 21:28, Dustin J. Mitchell wrote:
> On Thu, Jan 7, 2010 at 2:12 PM, Marcus Lindblom<macke at yar.nu>  wrote:
>    
>> (Also, I'd love to see some TLC given to the manual's layout/style,
>> similar to the new Python docs.)
>>      
> Agreed -- the current monolithic file is hard to patch, since the
> "diff" tells you nothing about the structural impact of the changes.
>
> I've started using sphinx for a few projects[1,2] and been very happy
> with it.  The format is easy to edit, without referring to any
> description of the format.  The interlinking is natural, and makes it
> very easy to organize the content in a way that will guide
> contributors to put new content in the right place.  It's also *very*
> well suited to Python documentation, with its ability to document
> classes, functions, methods, etc. cleanly and in a fashion that
> resembles docs.python.org.
>    
Righto then. :)
> I've toyed with spending a weekend converting the manual to Sphinx,
> but haven't found the free weekend yet.
>
>    
Perhaps this can serve as inspiration:
http://thomas.apestaart.org/download/tmp/buildbot/html/index.html
:)

I found it when searching for something buildbot related...

Cheers,
/Marcus




More information about the devel mailing list