[llvm] r298277 - Mention that the Sphinx docs build wants version 1.5 or later
Jonathan Roelofs via llvm-commits
llvm-commits at lists.llvm.org
Mon Mar 20 10:49:36 PDT 2017
Author: jroelofs
Date: Mon Mar 20 12:49:36 2017
New Revision: 298277
URL: http://llvm.org/viewvc/llvm-project?rev=298277&view=rev
Log:
Mention that the Sphinx docs build wants version 1.5 or later
`misc.highlighting_failure` support was added to `suppress_warnings` in that
version, and the warnings-as-errors docs build relies on it.
Modified:
llvm/trunk/docs/GettingStarted.rst
Modified: llvm/trunk/docs/GettingStarted.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/GettingStarted.rst?rev=298277&r1=298276&r2=298277&view=diff
==============================================================================
--- llvm/trunk/docs/GettingStarted.rst (original)
+++ llvm/trunk/docs/GettingStarted.rst Mon Mar 20 12:49:36 2017
@@ -805,7 +805,8 @@ used by people developing LLVM.
+-------------------------+----------------------------------------------------+
| LLVM_ENABLE_SPHINX | Build sphinx-based documentation from the source |
| | code. This is disabled by default because it is |
-| | slow and generates a lot of output. |
+| | slow and generates a lot of output. Sphinx version |
+| | 1.5 or later recommended. |
+-------------------------+----------------------------------------------------+
| LLVM_BUILD_LLVM_DYLIB | Generate libLLVM.so. This library contains a |
| | default set of LLVM components that can be |
More information about the llvm-commits
mailing list