hanchenye-llvm-project/libunwind/docs
Martin Storsjo dbf17cf048 Fix a typo in the documentation. NFC.
llvm-svn: 313470
2017-09-16 20:52:05 +00:00
..
BuildingLibunwind.rst
CMakeLists.txt
README.txt
conf.py Bump docs version to 6.0 2017-07-19 13:49:39 +00:00
index.rst Fix a typo in the documentation. NFC. 2017-09-16 20:52:05 +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.