Go to file
Marshall Clow 70e8f59884 Fix a crasher found by libFuzzer
git-svn-id: https://llvm.org/svn/llvm-project/libcxx/trunk@245849 91177308-0d34-0410-b5e6-96231b3b80d8
2015-08-24 15:57:09 +00:00
cmake Fix default value for LLVM_INCLUDE_DOCS in out of tree build. 2015-08-22 20:26:42 +00:00
docs [libcxx] Add new Sphinx documentation 2015-08-22 19:40:49 +00:00
include Fix a crasher found by libFuzzer 2015-08-24 15:57:09 +00:00
lib [libcxx] Add "install-libcxx" target. 2015-08-19 17:41:53 +00:00
src Fix a typo: overidden -> overridden - Patch from Kai Zhao 2015-08-20 05:23:16 +00:00
test Fix a crasher found by libFuzzer 2015-08-24 15:57:09 +00:00
utils cleanup comments in sym_check 2015-03-27 06:04:37 +00:00
www Update some links so that they don't point at the (private) WG21 Wiki 2015-08-05 14:36:42 +00:00
.arcconfig Update Arcanist config to point to reviews.llvm.org 2014-06-10 18:29:36 +00:00
.gitignore [libc++] Refactor test components into modules. 2015-01-09 18:03:29 +00:00
CMakeLists.txt [libcxx] Add new Sphinx documentation 2015-08-22 19:40:49 +00:00
CREDITS.TXT Add self to CREDITS.txt 2015-02-26 00:48:22 +00:00
LICENSE.TXT Update copyright year to 2015. 2015-03-12 20:13:11 +00:00
Makefile Revert "Fix installheaders target's permissions" 2014-12-16 05:28:07 +00:00
TODO.TXT Remove completed items from TODO.TXT 2015-08-20 19:22:35 +00:00

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.