llvm-project/libunwind/docs
Jordan Rupprecht 7bb861e83b Add a blank line to docs/README.txt test commit access
Subscribers: christof, cfe-commits

Differential Revision: https://reviews.llvm.org/D48785

llvm-svn: 336006
2018-06-29 19:05:21 +00:00
..
BuildingLibunwind.rst
CMakeLists.txt
README.txt Add a blank line to docs/README.txt test commit access 2018-06-29 19:05:21 +00:00
conf.py Update docs version to 7.0 2018-01-03 15:58:08 +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.