From 56d588a7751d9c013d20d8820be103f57cbba191 Mon Sep 17 00:00:00 2001 From: Jonathan Roelofs Date: Mon, 20 Mar 2017 17:49:36 +0000 Subject: [PATCH] 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. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@298277 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/GettingStarted.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/GettingStarted.rst b/docs/GettingStarted.rst index 2918a5cd8f4..6f8a4bb850f 100644 --- a/docs/GettingStarted.rst +++ b/docs/GettingStarted.rst @@ -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 | -- 2.50.1