[Zorg][PATCH] Add Sphinx documentation factory and builder for LLVM, Clang and LLD

Dan Liew dan at su-root.co.uk
Wed Aug 6 08:18:15 PDT 2014


Hi All,

Attached is a patch to Zorg that adds

* A factory for building Sphinx documentation of various LLVM projects
(right now LLVM, Clang and LLD)

* Three builders (one for each project). They all use the gribozabr4
slave. I could of done a single builder that builds the docs for all
three projects but I figured it would be less noise if people were
notified on a per-project basis of breakages. Although I'm not sure if
I've implemented this correctly.

Sorry I meant to do this quite a while a go but I've been busy and the
current state of Zorg was a little bit of a barrier.

The ``getSphinxDocsBuildFactory()`` factory has been tested locally on
my machine but the rest of it is not testable on my machine. This
factory uses the CMake infrastruture for building the sphinx
documentation which currently implies Sphinx warnings are treated as
errors.

@Sean Silva : I know you disagree with having Sphinx warnings as
errors but I think for the buildbot that this is probably fine. A
bi-product of me doing this work is I'm probably going to try to
document using the buildbot in the near future because my experience
in getting a build master working locally on my machine was not
particularly pleasant.

Thanks,
Dan.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: 0001-Add-Sphinx-documentation-Factory-and-builders-to-zor.patch
Type: text/x-patch
Size: 6722 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20140806/003897f4/attachment.bin>


More information about the llvm-commits mailing list