diff options
Diffstat (limited to 'docs/README.txt')
| -rw-r--r-- | docs/README.txt | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/README.txt b/docs/README.txt new file mode 100644 index 0000000..968982f --- /dev/null +++ b/docs/README.txt @@ -0,0 +1,13 @@ +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. |