llvm-project/libunwind/docs
xgupta 77fecc0795 [NFC][libunbind] Fix Sphinx error during CMake invocation
An error has occurred when I build libunwind with -DLLVM_BUILD_DOCS=ON.

Reviewed By: #libunwind, compnerd

Differential Revision: https://reviews.llvm.org/D96107
2021-02-11 06:52:24 +05:30
..
BuildingLibunwind.rst
CMakeLists.txt [NFC][libunbind] Fix Sphinx error during CMake invocation 2021-02-11 06:52:24 +05:30
README.txt
conf.py
index.rst [Branch-Rename] Fix some links 2021-02-01 16:43:21 +05:30

README.txt

libunwind Documentation
====================

The libunwind documentation is written using the Sphinx documentation generator. It is
currently tested with Sphinx 1.1.3.

To build the documents into html configure libunwind with the following cmake options:

  * -DLLVM_ENABLE_SPHINX=ON
  * -DLIBUNWIND_INCLUDE_DOCS=ON

After configuring libunwind with these options the make rule `docs-libunwind-html`
should be available.