llvm-project

History

Evgeniy Stepanov a66a7b30ce 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. llvm-svn: 250254		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	…
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	…
UsingLibcxx.rst	…
conf.py	…
index.rst	[libcxx] Capture configuration information when installing the libc++ headers	2015-10-13 22:12: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.