llvm-capstone/libunwind/docs
Tobias Hieta 7bfaa0f09d
[NFC][Py Reformat] Reformat python files in libcxx/libcxxabi
This is an ongoing series of commits that are reformatting our
Python code.

Reformatting is done with `black`.

If you end up having problems merging this commit because you
have made changes to a python file, the best way to handle that
is to run git checkout --ours <yourfile> and then reformat it
with black.

If you run into any problems, post to discourse about it and
we will try to help.

RFC Thread below:

https://discourse.llvm.org/t/rfc-document-and-standardize-python-code-style

Reviewed By: #libc, kwk, Mordante

Differential Revision: https://reviews.llvm.org/D150763
2023-05-25 11:15:34 +02:00
..
BuildingLibunwind.rst
CMakeLists.txt
conf.py [NFC][Py Reformat] Reformat python files in libcxx/libcxxabi 2023-05-25 11:15:34 +02: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.