xref: /llvm-project/libunwind/docs/README.txt (revision ca6d35b2a9e237bb1f1ee54fb04827c26b8a1c17)
1*af9d03aaSJonathan Roelofslibunwind Documentation
2*af9d03aaSJonathan Roelofs====================
3*af9d03aaSJonathan Roelofs
4*af9d03aaSJonathan RoelofsThe libunwind documentation is written using the Sphinx documentation generator. It is
5*af9d03aaSJonathan Roelofscurrently tested with Sphinx 1.1.3.
6*af9d03aaSJonathan Roelofs
7*af9d03aaSJonathan RoelofsTo build the documents into html configure libunwind with the following cmake options:
8*af9d03aaSJonathan Roelofs
9*af9d03aaSJonathan Roelofs  * -DLLVM_ENABLE_SPHINX=ON
10*af9d03aaSJonathan Roelofs  * -DLIBUNWIND_INCLUDE_DOCS=ON
11*af9d03aaSJonathan Roelofs
12*af9d03aaSJonathan RoelofsAfter configuring libunwind with these options the make rule `docs-libunwind-html`
13*af9d03aaSJonathan Roelofsshould be available.
14