diff options
| author | Jonathan Roelofs <jonathan@codesourcery.com> | 2017-03-20 17:49:36 +0000 |
|---|---|---|
| committer | Jonathan Roelofs <jonathan@codesourcery.com> | 2017-03-20 17:49:36 +0000 |
| commit | 8d1ba8943ff4282249d128e14cbe7fea8d7565c3 (patch) | |
| tree | 1f03772d984a2591202b7bc8ca735af071b05078 /llvm/docs | |
| parent | 8819c7387821de31caa09c94094db1f1a906ca4d (diff) | |
| download | bcm5719-llvm-8d1ba8943ff4282249d128e14cbe7fea8d7565c3.tar.gz bcm5719-llvm-8d1ba8943ff4282249d128e14cbe7fea8d7565c3.zip | |
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.
llvm-svn: 298277
Diffstat (limited to 'llvm/docs')
| -rw-r--r-- | llvm/docs/GettingStarted.rst | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/llvm/docs/GettingStarted.rst b/llvm/docs/GettingStarted.rst index 2918a5cd8f4..6f8a4bb850f 100644 --- a/llvm/docs/GettingStarted.rst +++ b/llvm/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 | |
