freebsd-dev/docs
2015-12-30 11:54:09 +00:00
..
DesignDocs Vendor import of libc++ trunk r256633: 2015-12-30 11:54:09 +00:00
BuildingLibcxx.rst Vendor import of libc++ trunk r256633: 2015-12-30 11:54:09 +00:00
CMakeLists.txt Vendor import of libc++ trunk r256633: 2015-12-30 11:54:09 +00:00
conf.py Vendor import of libc++ trunk r256633: 2015-12-30 11:54:09 +00:00
index.rst Vendor import of libc++ trunk r256633: 2015-12-30 11:54:09 +00:00
Makefile.sphinx Vendor import of libc++ trunk r256633: 2015-12-30 11:54:09 +00:00
README.txt Vendor import of libc++ trunk r256633: 2015-12-30 11:54:09 +00:00
TestingLibcxx.rst Vendor import of libc++ trunk r256633: 2015-12-30 11:54:09 +00:00
UsingLibcxx.rst Vendor import of libc++ trunk r256633: 2015-12-30 11:54:09 +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.