Skip to content

Commit f7f0362

Browse files
committedApr 19, 2019
[Docs] Add more info about building the docs
Including the C++ and Python reference. llvm-svn: 358777
1 parent d42b381 commit f7f0362

File tree

1 file changed

+27
-15
lines changed

1 file changed

+27
-15
lines changed
 

‎lldb/docs/resources/build.rst

+27-15
Original file line numberDiff line numberDiff line change
@@ -232,21 +232,6 @@ On NetBSD one might run:
232232
> pkgin install swig python27 cmake ninja-build
233233

234234

235-
If you wish to build the optional reference documentation, additional dependencies are required:
236-
237-
* Graphviz (for the 'dot' tool).
238-
* doxygen (only if you wish to build the C++ API reference)
239-
* epydoc (only if you wish to build the Python API reference)
240-
241-
242-
To install the prerequisites for building the documentation (on Debian/Ubuntu) do:
243-
244-
::
245-
246-
> sudo apt-get install doxygen graphviz
247-
> sudo pip install epydoc # or install package python-epydoc
248-
249-
250235
**Building LLDB**
251236

252237
We first need to checkout the source trees into the appropriate locations. Both
@@ -514,3 +499,30 @@ arm64 build:
514499

515500
Note that currently only lldb-server is functional on android. The lldb client
516501
is not supported and unlikely to work.
502+
503+
Building The Documentation
504+
--------------------------
505+
506+
If you wish to build the optional (reference) documentation, additional
507+
dependencies are required:
508+
509+
* Sphinx (for the website)
510+
* Graphviz (for the 'dot' tool)
511+
* doxygen (if you wish to build the C++ API reference)
512+
* epydoc (if you wish to build the Python API reference)
513+
514+
To install the prerequisites for building the documentation (on Debian/Ubuntu)
515+
do:
516+
517+
::
518+
519+
> sudo apt-get install doxygen graphviz python3-sphinx
520+
> sudo pip install epydoc
521+
522+
To build the documentation, build the desired target(s).
523+
524+
::
525+
526+
> cmake --build . --target docs-lldb-html
527+
> cmake --build . --target lldb-cpp-doc
528+
> cmake --build . --target lldb-python-doc

0 commit comments

Comments
 (0)