llvm-project

History

Eric Fiselier 7946c3f0e2 Fix errors in documentation llvm-svn: 268709		2016-05-06 04:49:30 +00:00
..
DesignDocs	Use __config_site when building libc++. Also cleanup ABI versioning doc	2015-10-14 00:22:05 +00:00
BuildingLibcxx.rst	Add documentation for new experimental library	2016-05-03 22:32:08 +00:00
CMakeLists.txt	…
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	Fix sphinx build. This is a temporary solution.	2016-05-05 08:12:25 +00:00
UsingLibcxx.rst	Fix errors in documentation	2016-05-06 04:49:30 +00:00
conf.py	Update version numbers in docs	2016-05-03 22:50:33 +00:00
index.rst	Add links to libc++ code coverage and builders	2015-10-15 03:27:02 +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.