Skip to content

[LLDB] Update docs on building documentation #69858

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 23, 2023
Merged

[LLDB] Update docs on building documentation #69858

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d94c5f
[LLDB] Update docs on building documentation
boomanaiden154 Oct 21, 2023
751343c
Replace Swig with SWIG to address reviewer feedback
boomanaiden154 Oct 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions lldb/docs/resources/build.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down