[Buildbot-devel] Sphinx builder

[Benoît Allard]

On 7/28/2011 6:28 PM, Dustin J. Mitchell wrote:
> 2011/7/28 Benoît Allard<benoit at aeteurope.nl>:
>> Before I begin writing my own one, I was wondering if someone has a sphinx_
>> buildstep_ they could share ? I'm talking about the documentation generator
>> project based on docutils.
>
> I don't have a step class, but I do have some config to do so in the
> metabuildbot (for the tutorial):
>    https://github.com/buildbot/metabbotcfg/blob/master/builders.py#L219
> although now that I look it just installs sphinx in the virtualenv and
> invokes 'make tutorial', so that's not exciting at all.
>
> Now that we have step tests, I'd be happy to see a BuildSphinx step
> merged into Buildbot - there are knobs worth tweaking to control
> rebuilding files that have changed or rebuilding from scratch, target
> directories, etc.

Na, it's just a matter of invoking `sphinx-build` let the parameters be, 
well ... parameterizable, and parse the output ... I'll look into it ...

>
>> As a side note, how is the conversion_ of the buildbot doc to
>> restructuredText progressing ? I could donate some spare cycles to convert
>> one file or two, I'm really charmed by it ...
>
> I like Sphinx a lot, too.  I've worked on it a bit, but have put it
> aside to concentrate on keeping up with the summer of code and other
> patch submissions.  My plan was to write a converter that would do the
> bulk of the work for me, and then do some manual fixups.  The work in
> progress is here:
>    https://github.com/djmitche/buildbot/tree/sphinxdocs
>

While I do think, a script is for sure a general nice idea, I also think 
that we might spend more time tweaking the script, and manually going 
through the output, than doing the conversion once for all. Beside that 
such a script more has its place inside the docutils or sphinx project. 
I consider this as a one-time operation, not something we'll do every week.

Simon did it once. Taking one of his files as example, it should be 
possible to process the doc once again ...

Or even better, if we apply Simon's diff on the 0.8.1, and then merge it 
with the head, we will only have to process the difference in the doc 
since then ! Thanks three-way-merge !

I'll take some time next week to see what I can do ...

Regards,
Benoit

-------------- next part --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/pkcs7-signature
Size: 4936 bytes
Desc: S/MIME Cryptographic Signature
URL: <http://buildbot.net/pipermail/devel/attachments/20110729/27cf96e3/attachment.bin>