]> granicus.if.org Git - llvm/commitdiff
Mention that the Sphinx docs build wants version 1.5 or later
authorJonathan Roelofs <jonathan@codesourcery.com>
Mon, 20 Mar 2017 17:49:36 +0000 (17:49 +0000)
committerJonathan Roelofs <jonathan@codesourcery.com>
Mon, 20 Mar 2017 17:49:36 +0000 (17:49 +0000)
`misc.highlighting_failure` support was added to `suppress_warnings` in that
version, and the warnings-as-errors docs build relies on it.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@298277 91177308-0d34-0410-b5e6-96231b3b80d8

docs/GettingStarted.rst

index 2918a5cd8f4e29aa95664a1a7d6020d3360e092e..6f8a4bb850f5f9fba6e960f6a7a0fc097dea0aa9 100644 (file)
@@ -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         |