hanchenye-llvm-project/libunwind/docs
Hans Wennborg a760fe6484 Update docs version and clear release notes after 8.0.0 version bump
llvm-svn: 338561
2018-08-01 14:14:09 +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 and clear release notes after 8.0.0 version bump 2018-08-01 14:14:09 +00:00
index.rst

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.