llvm-project/libunwind/docs
Sylvestre Ledru 72fd1033ea Doc: Links should use https 2020-03-22 22:49:33 +01:00
..
BuildingLibunwind.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
CMakeLists.txt
README.txt NFC: Test commit access 2018-08-16 16:55:07 +00:00
conf.py Bump the trunk major version to 11 2020-01-15 13:38:01 +01:00
index.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00

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.