On 3 April 2017 at 13:59, Daniel Berlin via llvm-dev <llvm-dev at lists.llvm.org> wrote:> > > On Mon, Apr 3, 2017 at 5:51 AM, Dean Michael Berris via llvm-dev > <llvm-dev at lists.llvm.org> wrote: >> >> >> On 3 Apr 2017, at 22:47, Alex Denisov <1101.debian at gmail.com> wrote: >> >> The HTML generated using sphinx[1]. >> At the bottom of each page you can see actual version of sphinx used to >> generate this page. >> >> >> Thanks -- interesting that the docs haven't been updated since March 15th: >> >> © Copyright 2003-2017, LLVM Project. Last updated on 2017-03-16. Created >> using Sphinx 1.4.5. >> >> - How should I best debug whether the docs (in RST) are syntactically >> correct? Are there recommended practices for doing a sanity check on the >> docs? >> >> >> Just run correct version of sphinx locally and check whether everything is >> correct. >> >> >> I see -- nothing part of the CMake build, say "check-docs" that would do >> this? >> > > LLVM_ENABLE_SPHINX will turn it on. > //Use Sphinx to generate llvm documentation. > LLVM_ENABLE_SPHINX:BOOL=OFFJust to add to that the targets you want are docs-llvm-html docs-llvm-man e.g. ``` ninja docs-llvm-html ``` as Daniel mentioned you need to set `LLVM_ENABLE_SPHINX` to on.
Dean Michael Berris via llvm-dev
2017-Apr-04 02:07 UTC
[llvm-dev] Debugging Docs and llvm.org/docs/
> On 4 Apr 2017, at 01:27, Dan Liew <dan at su-root.co.uk> wrote: > > On 3 April 2017 at 13:59, Daniel Berlin via llvm-dev > <llvm-dev at lists.llvm.org> wrote: >> >> >> On Mon, Apr 3, 2017 at 5:51 AM, Dean Michael Berris via llvm-dev >> <llvm-dev at lists.llvm.org> wrote: >>> >>> >>> On 3 Apr 2017, at 22:47, Alex Denisov <1101.debian at gmail.com> wrote: >>> >>> The HTML generated using sphinx[1]. >>> At the bottom of each page you can see actual version of sphinx used to >>> generate this page. >>> >>> >>> Thanks -- interesting that the docs haven't been updated since March 15th: >>> >>> © Copyright 2003-2017, LLVM Project. Last updated on 2017-03-16. Created >>> using Sphinx 1.4.5. >>> >>> - How should I best debug whether the docs (in RST) are syntactically >>> correct? Are there recommended practices for doing a sanity check on the >>> docs? >>> >>> >>> Just run correct version of sphinx locally and check whether everything is >>> correct. >>> >>> >>> I see -- nothing part of the CMake build, say "check-docs" that would do >>> this? >>> >> >> LLVM_ENABLE_SPHINX will turn it on. >> //Use Sphinx to generate llvm documentation. >> LLVM_ENABLE_SPHINX:BOOL=OFF > > Just to add to that the targets you want are > > docs-llvm-html > docs-llvm-man > > e.g. > > ``` > ninja docs-llvm-html > ``` > > as Daniel mentioned you need to set `LLVM_ENABLE_SPHINX` to on.Cool stuff, thanks! -- Dean -------------- next part -------------- An HTML attachment was scrubbed... URL: <http://lists.llvm.org/pipermail/llvm-dev/attachments/20170404/ab5ffdc1/attachment.html>