llvm-project/libunwind/docs
2023-01-24 22:57:27 -08:00
..
BuildingLibunwind.rst Revert "[cmake] Use CMAKE_INSTALL_LIBDIR too" 2022-08-18 22:46:32 -04:00
CMakeLists.txt
conf.py Bump the trunk major version to 17 2023-01-24 22:57:27 -08:00
index.rst
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.