generic-library/cxx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
main
cxx/docs
History
Eric Fiselier 8459d20624 Update paths in libc++ build instructions. Patch from Jonathan Anderson. 
git-svn-id: https://llvm.org/svn/llvm-project/libcxx/trunk@255561 91177308-0d34-0410-b5e6-96231b3b80d8
2015-12-14 22:26:28 +00:00
..
DesignDocs Use __config_site when building libc++. Also cleanup ABI versioning doc 2015-10-14 00:22:05 +00:00
BuildingLibcxx.rst Update paths in libc++ build instructions. Patch from Jonathan Anderson. 2015-12-14 22:26:28 +00:00
CMakeLists.txt [libcxx] Add new Sphinx documentation 2015-08-22 19:40:49 +00:00
conf.py [libcxx] Add new Sphinx documentation 2015-08-22 19:40:49 +00:00
index.rst Add links to libc++ code coverage and builders 2015-10-15 03:27:02 +00:00
Makefile.sphinx Test commit for builder 2015-09-05 05:29:23 +00:00
README.txt Remove test commit. 2015-09-05 05:38:50 +00:00
TestingLibcxx.rst Update testing guide for libc++ 2015-10-14 20:44:44 +00:00
UsingLibcxx.rst [libcxx] Make libc++.so a linker script by default on most platforms. 2015-10-15 22:41:51 +00:00

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.