https://github.com/boomanaiden154 created https://github.com/llvm/llvm-project/pull/69834
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. >From dfa7722665bbf526516bb13675b5728ed5e75c7e Mon Sep 17 00:00:00 2001 From: Aiden Grossman <agrossman...@yahoo.com> Date: Sat, 21 Oct 2023 03:27:03 -0700 Subject: [PATCH] [LLDB] Update docs on building documentation 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. --- lldb/docs/resources/build.rst | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/lldb/docs/resources/build.rst b/lldb/docs/resources/build.rst index b405a20e239912c..ae3a8ccccce4a25 100644 --- a/lldb/docs/resources/build.rst +++ b/lldb/docs/resources/build.rst @@ -403,13 +403,21 @@ dependencies are required: * Sphinx (for the website and the Python API reference) * Graphviz (for the 'dot' tool) * doxygen (if you wish to build the C++ API reference) +* Swig (for generating Python bindings) -To install the prerequisites for building the documentation (on Debian/Ubuntu) +To install the system prerequisites for building the documentation (on Debian/Ubuntu) do: :: - $ sudo apt-get install doxygen graphviz python3-sphinx + $ sudo apt-get install doxygen graphviz swig + +To install Sphinx and its dependencies, use the ``requirements.txt`` available within LLVM +to ensure you get a working configuration: + +:: + + $ pip3 install -r /path/to/llvm-project/llvm/docs/requirements.txt To build the documentation, configure with ``LLVM_ENABLE_SPHINX=ON`` and build the desired target(s). _______________________________________________ lldb-commits mailing list lldb-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits
