[Buildbot-devel] Sphinx builder

Dustin J. Mitchell dustin at v.igoro.us
Thu Jul 28 16:28:16 UTC 2011


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.

> 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




More information about the devel mailing list