Skip to content

Commit 2f15082

Browse files
[LLDB] Update docs on building documentation (#69858)
This patch updates the documentation to match recent changes and make it more clear. More specifically, the process for installing sphinx has changed with the transition to myst with the requirements.txt in llvm/docs being the preferred method for installation now. In addition, the docs-lldb-html target is never generated if swig isn't installed, so having something expliti in the documentation section (even if it is mentioned as a dependency of lldb itself above) probably doesn't hurt.
1 parent 159614a commit 2f15082

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

lldb/docs/resources/build.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -403,13 +403,21 @@ dependencies are required:
403403
* Sphinx (for the website and the Python API reference)
404404
* Graphviz (for the 'dot' tool)
405405
* doxygen (if you wish to build the C++ API reference)
406+
* SWIG (for generating Python bindings)
406407

407-
To install the prerequisites for building the documentation (on Debian/Ubuntu)
408+
To install the system prerequisites for building the documentation (on Debian/Ubuntu)
408409
do:
409410

410411
::
411412

412-
$ sudo apt-get install doxygen graphviz python3-sphinx
413+
$ sudo apt-get install doxygen graphviz swig
414+
415+
To install Sphinx and its dependencies, use the ``requirements.txt`` available within LLVM
416+
to ensure you get a working configuration:
417+
418+
::
419+
420+
$ pip3 install -r /path/to/llvm-project/llvm/docs/requirements.txt
413421

414422
To build the documentation, configure with ``LLVM_ENABLE_SPHINX=ON`` and build the desired target(s).
415423

0 commit comments

Comments
 (0)