hanchenye-llvm-project/libunwind/docs
Jordan Rupprecht ca6d35b2a9 NFC: Test commit access
Testing commit access from a new machine, so using this as an opportunity to revert my old test access commit (r336006) that I never cleaned up.

llvm-svn: 339899
2018-08-16 16:55:07 +00:00
..
BuildingLibunwind.rst
CMakeLists.txt
README.txt NFC: Test commit access 2018-08-16 16:55:07 +00:00
conf.py Update docs version and clear release notes after 8.0.0 version bump 2018-08-01 14:14:09 +00:00
index.rst [docs] Mention that dwarf unwinding should be supported on arm64/windows 2017-11-16 07:16:36 +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.