darling-libcxx/docs
Evgeniy Stepanov 4f01aa8fb8 ABI versioning macros for libc++.
C++ macros and CMake options that specify the default ABI version of
the library, and can be overridden to pick up new ABI-changing
features.

git-svn-id: https://llvm.org/svn/llvm-project/libcxx/trunk@250254 91177308-0d34-0410-b5e6-96231b3b80d8
2015-10-13 23:48:28 +00:00
..
DesignDocs Fix whitespace in doc 2015-10-13 22:22:42 +00:00
Abi.rst ABI versioning macros for libc++. 2015-10-13 23:48:28 +00:00
BuildingLibcxx.rst ABI versioning macros for libc++. 2015-10-13 23:48: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 [libcxx] Capture configuration information when installing the libc++ headers 2015-10-13 22:12: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 [libcxx] Add new Sphinx documentation 2015-08-22 19:40:49 +00:00
UsingLibcxx.rst [libcxx] Add new Sphinx documentation 2015-08-22 19:40:49 +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.