aboutsummaryrefslogtreecommitdiff
path: root/libc/docs/README.txt
blob: c25000039994826b6e363aaad316836a3760f14e (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
  * -DLIBC_INCLUDE_DOCS=ON

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