llvm-project/libunwind/docs
Hans Wennborg 5852475e2c Bump the trunk major version to 11
and clear the release notes.
2020-01-15 13:38:01 +01:00
..
BuildingLibunwind.rst Adjust documentation for git migration. 2019-01-29 16:37:27 +00: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 [Docs] Modernize references to macOS 2019-05-30 16:46:22 +00: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.