llvm-project/libcxx/docs
Alexey Samsonov f094e0f3e3 [docs] Remove references to autoconf build.
llvm-svn: 259281
2016-01-30 01:11:42 +00:00
..
DesignDocs Use __config_site when building libc++. Also cleanup ABI versioning doc 2015-10-14 00:22:05 +00:00
BuildingLibcxx.rst [docs] Remove references to autoconf build. 2016-01-30 01:11:42 +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 Update testing guide for libc++ 2015-10-14 20:44:44 +00:00
UsingLibcxx.rst Add link to 3rd party GDB pretty-printers 2016-01-20 01:26:30 +00:00
conf.py
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.