| Jonathan Roelofs | af9d03a | 2017-03-28 15:21:43 | [diff] [blame] | 1 | libunwind Documentation |
| 2 | ==================== | ||||
| 3 | |||||
| 4 | The libunwind documentation is written using the Sphinx documentation generator. It is | ||||
| 5 | currently tested with Sphinx 1.1.3. | ||||
| 6 | |||||
| 7 | To build the documents into html configure libunwind with the following cmake options: | ||||
| 8 | |||||
| 9 | * -DLLVM_ENABLE_SPHINX=ON | ||||
| 10 | * -DLIBUNWIND_INCLUDE_DOCS=ON | ||||
| 11 | |||||
| 12 | After configuring libunwind with these options the make rule `docs-libunwind-html` | ||||
| 13 | should be available. | ||||