| Eric Fiselier | d720d1f | 2015-08-22 19:40:49 +0000 | [diff] [blame^] | 1 | libc++ Documentation |
| 2 | ==================== | ||||
| 3 | |||||
| 4 | The libc++ 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 libc++ with the following cmake options: | ||||
| 8 | |||||
| 9 | * -DLLVM_ENABLE_SPHINX=ON | ||||
| 10 | * -DLIBCXX_INCLUDE_DOCS=ON | ||||
| 11 | |||||
| 12 | After configuring libc++ with these options the make rule `docs-libcxx-html` | ||||
| 13 | should be available. | ||||