summaryrefslogtreecommitdiff
path: root/docs/README.txt
blob: 06d94f5b5fc48dd36ea501e8ab09ed9b8c110ec3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
libc++ Documentation
====================

The libc++ documentation is written using the Sphinx documentation generator. It is
currently tested with Sphinx 1.1.3.

To build the documents into html configure libc++ with the following cmake options:

  * -DLLVM_ENABLE_SPHINX=ON
  * -DLIBCXX_INCLUDE_DOCS=ON

After configuring libc++ with these options the make rule `docs-libcxx-html`
should be available.