<div dir="ltr">Thanks for the patch. I love the direction but I think it can be simplified quite a bit using the following information:<div><br></div><div>Note that Makefile.sphinx is just a "boilerplate" file generated by "sphinx-quickstart" and not integrated in any way with LLVM's build system. We don't need all the functionality in Makefile.sphinx; in fact, we really only need the default (`html`) (and clean obviously; and maybe `man` once we rig up the install of the manpages).</div>
<div><br></div><div><div>I don't think it is a good idea to add "linkcheck" as part of the build for two reasons:</div><div>1. we don't want the build to require an internet connection</div><div>2. we don't want to allow the content of an external website (which may change arbitrarily) to break the build.</div>
<div>Also, it's just not an actionable thing for your average developer.</div></div><div><br></div><div>Let's see what the patch looks like taking that into account.</div><div><br></div><div>Btw, Thanks for tackling issues at the intersection of the docs and the build system. Very brave. If you understand how the CMake install works, it would be a godsend to have it install the manpages (generated by Sphinx's `-b man`) as part of the usual install (if the docs were built, of course).<br>
</div><div><br></div><div>-- Sean Silva</div></div><div class="gmail_extra"><br><br><div class="gmail_quote">On Mon, Apr 14, 2014 at 3:36 PM, Daniel Liew <span dir="ltr"><<a href="mailto:daniel.liew@imperial.ac.uk" target="_blank">daniel.liew@imperial.ac.uk</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Hi,<br>
<br>
Attached is a patch (0001) that enables the Sphinx documentation to be<br>
built when using the CMake build system when LLVM_ENABLE_SPHINX is<br>
enabled (disabled by default).<br>
<br>
I've added quite a few sphinx build targets based on what is in<br>
docs/Makefile.sphinx but not all because they are more complicated.<br>
The only sphinx build target enabled by default when<br>
LLVM_ENABLE_SPHINX is enabled is "sphinx-llvm-html". I'm not sure if<br>
sphinx-llvm-json or sphinx-llvm-pickle is actually useful.<br>
<br>
It would be nice to enable sphinx-llvm-linkcheck by default (when<br>
LLVM_ENABLE_SPHINX is enabled) so people could be made aware of broken<br>
links in the documentation but there are already quite a few broken<br>
links and I don't want to break any builds that might decide to use<br>
LLVM_ENABLE_SPHINX and LLVM_BUILD_DOCS for now.<br>
<br>
I've tested this on Linux with sphinx 1.2.2 with make and Ninja.<br>
<br>
Please review.<br>
<br>
Thanks,<br>
Dan.<br>
<br>_______________________________________________<br>
llvm-commits mailing list<br>
<a href="mailto:llvm-commits@cs.uiuc.edu">llvm-commits@cs.uiuc.edu</a><br>
<a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits" target="_blank">http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits</a><br>
<br></blockquote></div><br></div>