Go to file
Dimitry Andric 4a2db4d30e Vendor import of libc++ trunk r291274:
https://llvm.org/svn/llvm-project/libcxx/trunk@291274
2017-01-06 20:13:54 +00:00
benchmarks Vendor import of libc++ trunk r290819: 2017-01-02 19:18:58 +00:00
cmake Vendor import of libc++ trunk r291274: 2017-01-06 20:13:54 +00:00
docs Vendor import of libc++ trunk r291274: 2017-01-06 20:13:54 +00:00
include Vendor import of libc++ trunk r291274: 2017-01-06 20:13:54 +00:00
lib Vendor import of libc++ trunk r291012: 2017-01-04 22:11:41 +00:00
src Vendor import of libc++ trunk r291274: 2017-01-06 20:13:54 +00:00
test Vendor import of libc++ trunk r291274: 2017-01-06 20:13:54 +00:00
utils Vendor import of libc++ trunk r291012: 2017-01-04 22:11:41 +00:00
www Vendor import of libc++ trunk r291274: 2017-01-06 20:13:54 +00:00
.arcconfig Vendor import of libc++ release_39 branch r276489: 2016-07-23 20:47:26 +00:00
.clang-format Vendor import of libc++ trunk r291012: 2017-01-04 22:11:41 +00:00
.gitignore Vendor import of libc++ trunk r290819: 2017-01-02 19:18:58 +00:00
CMakeLists.txt Vendor import of libc++ trunk r291012: 2017-01-04 22:11:41 +00:00
CREDITS.TXT Vendor import of libc++ release_39 branch r276489: 2016-07-23 20:47:26 +00:00
LICENSE.TXT Vendor import of libc++ trunk r291012: 2017-01-04 22:11:41 +00:00
NOTES.TXT Vendor import of libc++ trunk r290819: 2017-01-02 19:18:58 +00:00
TODO.TXT Vendor import of libc++ trunk r290819: 2017-01-02 19:18:58 +00:00

docs/README.txt

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.