[llvm-dev] Building a single .rst file

[Xing GUO via llvm-dev]

On 7/29/20, Xing GUO <higuoxing at gmail.com> wrote:
> On 7/29/20, Paul C. Anagnostopoulos via llvm-dev
> <llvm-dev at lists.llvm.org> wrote:
>> Folks,
>>
>> Total newbie here. What is the simplest way to build a single .rst file
>> so
>> that I can look at the generated HTML? I have CMake, Python, and Sphinx
>> installed.
>
> Hi Paul,
>
> I'm not sure if there are ways to build a single .rst file. But I
> usually build LLVM documentation via the following steps.
>
> ```
> $ cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Release
> -DLLVM_ENABLE_SPHINX=On $YOUR_LLVM_PROJECT_PATH/llvm
> $ make docs-llvm-html
> ```

Note: LLVM treats warnings as errors by default, if you want to
suppress them you can pass "-DSPHINX_WARNINGS_AS_ERRORS=Off" to cmake.
You are able to find some useful options by searching "sphinx" here
[1].

[1] https://llvm.org/docs/CMake.html

Best Regards,
Xing
>
>>
>> ~~ Paul
>>
>> _______________________________________________
>> LLVM Developers mailing list
>> llvm-dev at lists.llvm.org
>> https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev
>>
>
>
> --
> Cheers,
> Xing
>


-- 
Cheers,
Xing