[Buildbot-devel] Buildbot documentation in RST/Sphinx

Dustin J. Mitchell dustin at v.igoro.us
Sat Mar 19 17:08:48 UTC 2011

On Sat, Mar 19, 2011 at 6:37 AM, Simon Kennedy <sdk at sffjunkie.co.uk> wrote:
> When I was starting to read the buildbot docs it felt like I was
> spending more time changing pages than reading the text and so in order

I'm sure you've noticed that the documentation is also available as a
single page, right?

> to speed up my reading I started to create the docs in RST/Sphinx with
> some of the sections joined together.

This is great - I had been considering doing so for a while now:
Lukas merged a copy of Thomas's tutorial during the PyCon sprints this
week, and that is in RST, so I think it makes sense to convert all the

> It's the docs from version 0.8.1

Unfortunately, this doesn't do much good in terms of merging to trunk
- most likely hand-applying all docs changes since 0.8.1 would be more
difficult than simply reformatting the docs on master.

Assuming you used some scripts to do this, could you re-run them on
the master documentation, format it to your liking, and send along a
pull request?


P.S. For those who have lots of docs links in your awesomebar, I'll
make the top 20 or so documentation pages redirect to the appropriate
place in the new docs.

More information about the devel mailing list