hanchenye-llvm-project

History

Hans Wennborg dd2f4e0288 Bump docs version to 6.0 llvm-svn: 308462		2017-07-19 13:46:11 +00:00
..
DesignDocs	[libc++] class template -> template class. NFC	2017-07-13 22:08:59 +00:00
BuildingLibcxx.rst	[libcxx][CMake] Add install path variable to allow overriding the destination	2017-07-11 02:39:50 +00:00
CMakeLists.txt	docs: Fix Sphinx detection with out-of-tree builds	2017-05-09 11:18:03 +00:00
Makefile.sphinx	…
README.txt	…
TestingLibcxx.rst	Fix misspelling of environment throughout libc++	2017-05-09 23:47:20 +00:00
UsingLibcxx.rst	[libc++] Add _LIBCPP_DISABLE_EXTERN_TEMPLATE config option	2017-04-13 20:13:32 +00:00
conf.py	Bump docs version to 6.0	2017-07-19 13:46:11 +00:00
index.rst	Add markup for libc++ dylib availability	2017-05-04 17:08:54 +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.