hanchenye-llvm-project/libcxx/docs
Eric Fiselier 29ada6d178 Use __config_site when building libc++. Also cleanup ABI versioning doc
llvm-svn: 250261
2015-10-14 00:22:05 +00:00
..
DesignDocs Use __config_site when building libc++. Also cleanup ABI versioning doc 2015-10-14 00:22:05 +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 Use __config_site when building libc++. Also cleanup ABI versioning doc 2015-10-14 00:22:05 +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.