[Lldb-commits] [lldb] 663612d - [lldb] Remove references to epydoc from the documentation
Jonas Devlieghere via lldb-commits
lldb-commits at lists.llvm.org
Thu Jun 16 15:17:46 PDT 2022
Author: Jonas Devlieghere
Date: 2022-06-16T15:17:40-07:00
New Revision: 663612dfd8f63e82936f32755fbba2aa219a7ae0
URL: https://github.com/llvm/llvm-project/commit/663612dfd8f63e82936f32755fbba2aa219a7ae0
DIFF: https://github.com/llvm/llvm-project/commit/663612dfd8f63e82936f32755fbba2aa219a7ae0.diff
LOG: [lldb] Remove references to epydoc from the documentation
We no longer rely on epydoc but instead use a sphinx plugin to generate
the Python API reference.
Added:
Modified:
lldb/docs/resources/build.rst
Removed:
################################################################################
diff --git a/lldb/docs/resources/build.rst b/lldb/docs/resources/build.rst
index 5e67955c9c104..c44bdeee22c89 100644
--- a/lldb/docs/resources/build.rst
+++ b/lldb/docs/resources/build.rst
@@ -391,10 +391,9 @@ Building the Documentation
If you wish to build the optional (reference) documentation, additional
dependencies are required:
-* Sphinx (for the website)
+* Sphinx (for the website and the Python API reference)
* Graphviz (for the 'dot' tool)
* doxygen (if you wish to build the C++ API reference)
-* epydoc (if you wish to build the Python API reference)
To install the prerequisites for building the documentation (on Debian/Ubuntu)
do:
@@ -402,7 +401,6 @@ do:
::
$ sudo apt-get install doxygen graphviz python3-sphinx
- $ sudo pip install epydoc
To build the documentation, configure with ``LLVM_ENABLE_SPHINX=ON`` and build the desired target(s).
@@ -411,7 +409,6 @@ To build the documentation, configure with ``LLVM_ENABLE_SPHINX=ON`` and build t
$ ninja docs-lldb-html
$ ninja docs-lldb-man
$ ninja lldb-cpp-doc
- $ ninja lldb-python-doc
Cross-compiling LLDB
--------------------
More information about the lldb-commits
mailing list