llvm-project

History

Simon Pilgrim 527654dceb [libunwind] Attempt to fix broken sphinx doc link `bbce75e352` replaced `LLVM Bugzilla` with `LLVM bug tracker`		2022-02-05 21:05:01 +00:00
..
BuildingLibunwind.rst	[runtimes] Remove support for GCC-style 32 bit multilib builds	2021-12-01 12:57:01 -05:00
CMakeLists.txt	[NFC][libunbind] Fix Sphinx error during CMake invocation	2021-02-11 06:52:24 +05:30
README.txt	…
conf.py	Bump the trunk major version to 15	2022-02-01 23:54:52 -08:00
index.rst	[libunwind] Attempt to fix broken sphinx doc link	2022-02-05 21:05:01 +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.