[PATCH] Allow CMake to build Sphinx documentation

Daniel Liew daniel.liew at imperial.ac.uk
Mon Apr 14 12:36:16 PDT 2014


Hi,

Attached is a patch (0001) that enables the Sphinx documentation to be
built when using the CMake build system when LLVM_ENABLE_SPHINX is
enabled (disabled by default).

I've added quite a few sphinx build targets based on what is in
docs/Makefile.sphinx but not all because they are more complicated.
The only sphinx build target enabled by default when
LLVM_ENABLE_SPHINX is enabled is "sphinx-llvm-html". I'm not sure if
sphinx-llvm-json or sphinx-llvm-pickle is actually useful.

It would be nice to enable sphinx-llvm-linkcheck by default (when
LLVM_ENABLE_SPHINX is enabled) so people could be made aware of broken
links in the documentation but there are already quite a few broken
links and I don't want to break any builds that might decide to use
LLVM_ENABLE_SPHINX and LLVM_BUILD_DOCS for now.

I've tested this on Linux with sphinx 1.2.2 with make and Ninja.

Please review.

Thanks,
Dan.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: 0001-Added-Sphinx-documentation-generation-to-CMake-build.patch
Type: text/x-patch
Size: 6569 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20140414/ad6de470/attachment.bin>


More information about the llvm-commits mailing list