Building a single .rst file

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.

~~ Paul

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

Best Regards,
Xing

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

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.

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.

James

Is "Unix Makefiles" what I want if I am building on Windows using GNU make?

Is "Unix Makefiles" what I want if I am building on Windows using GNU make?

Yes, exactly.

Best Regards,
Xing

I hope you won't mind me continuing to pester you with build questions.

I've managed to get the build going. One of the things CMake does is create a file a.exe that tries to figure out which version of the C compiler is available. Malwarebytes does not like that executable. Has anyone run into this problem?

Meanwhile, I've told Malwarebytes not to worry about the build directory or its subdirectories.

Ah, now I have more information from Microsoft Security Essentials, also concerning a.exe. The Trojan is called Win32/Fuery.C!cl

I hope you won't mind me continuing to pester you with build
questions.

I've managed to get the build going. One of the things CMake does is
create a file a.exe that tries to figure out which version of the C
compiler is available. Malwarebytes does not like that executable.
Has anyone run into this problem?

Meanwhile, I've told Malwarebytes not to worry about the build
directory or its subdirectories.

Ah, now I have more information from Microsoft Security Essentials,
also concerning a.exe. The Trojan is called Win32/Fuery.C!cl

------------------------------
Category: Trojan

Description: This program is dangerous and executes commands from an
attacker.

Recommended action: Remove this software immediately.

Items:
file:C:\LLVM\Build\CMakeFiles\3.18.0\CompilerIdC\a.exe

Get more information about this item online.
---------------------------------

Completely harmless, see here.
https://cmake.org/pipermail/cmake/2018-June/067667.htmlhttps://cmake.org/pipermail/cmake/2018-June/067672.html
Basically thats just antivirus being overly sensitive.
A lot of antivirus software on windows complain when they see any `.exe` file which is why I find them mostly pointless.

Yes, I figured it was a false positive. This is only the second false positive I've seen in 20 years.