<div dir="ltr"><div>Just don't forget that if you do disable the warnings-as-errors bit, you'll still need to fix the warnings, since they'll cause build-bot failures.</div><div><br></div><div>Also, I think you'll need some python modules installed. I forget which (recommonmark sounds right to me), so it might just be best to try the build as Xing suggested and see what's missing.</div><div><br></div><div>James<br></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Wed, 29 Jul 2020 at 03:57, Xing GUO via llvm-dev <<a href="mailto:llvm-dev@lists.llvm.org">llvm-dev@lists.llvm.org</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">On 7/29/20, Xing GUO <<a href="mailto:higuoxing@gmail.com" target="_blank">higuoxing@gmail.com</a>> wrote:<br>
> On 7/29/20, Paul C. Anagnostopoulos via llvm-dev<br>
> <<a href="mailto:llvm-dev@lists.llvm.org" target="_blank">llvm-dev@lists.llvm.org</a>> wrote:<br>
>> Folks,<br>
>><br>
>> Total newbie here. What is the simplest way to build a single .rst file<br>
>> so<br>
>> that I can look at the generated HTML? I have CMake, Python, and Sphinx<br>
>> installed.<br>
><br>
> Hi Paul,<br>
><br>
> I'm not sure if there are ways to build a single .rst file. But I<br>
> usually build LLVM documentation via the following steps.<br>
><br>
> ```<br>
> $ cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Release<br>
> -DLLVM_ENABLE_SPHINX=On $YOUR_LLVM_PROJECT_PATH/llvm<br>
> $ make docs-llvm-html<br>
> ```<br>
<br>
Note: LLVM treats warnings as errors by default, if you want to<br>
suppress them you can pass "-DSPHINX_WARNINGS_AS_ERRORS=Off" to cmake.<br>
You are able to find some useful options by searching "sphinx" here<br>
[1].<br>
<br>
[1] <a href="https://llvm.org/docs/CMake.html" rel="noreferrer" target="_blank">https://llvm.org/docs/CMake.html</a><br>
<br>
Best Regards,<br>
Xing<br>
><br>
>><br>
>> ~~ Paul<br>
>><br>
>> _______________________________________________<br>
>> LLVM Developers mailing list<br>
>> <a href="mailto:llvm-dev@lists.llvm.org" target="_blank">llvm-dev@lists.llvm.org</a><br>
>> <a href="https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev" rel="noreferrer" target="_blank">https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev</a><br>
>><br>
><br>
><br>
> --<br>
> Cheers,<br>
> Xing<br>
><br>
<br>
<br>
-- <br>
Cheers,<br>
Xing<br>
_______________________________________________<br>
LLVM Developers mailing list<br>
<a href="mailto:llvm-dev@lists.llvm.org" target="_blank">llvm-dev@lists.llvm.org</a><br>
<a href="https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev" rel="noreferrer" target="_blank">https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev</a><br>
</blockquote></div>