hanchenye-llvm-project

History

Shoaib Meenai 1b0bda3310 [libc++] Correct macro name in documenation The macro is named `_LIBCPP_TEMPLATE_VIS`, not `_LIBCPP_TEMPLATE_ONLY`. No functional change. llvm-svn: 291330		2017-01-07 02:45:35 +00:00
..
DesignDocs	[libc++] Correct macro name in documenation	2017-01-07 02:45:35 +00:00
BuildingLibcxx.rst	Add start of filesystem benchmarks	2016-10-30 22:53:00 +00:00
CMakeLists.txt	…
Makefile.sphinx	Attempt to fix Sphinx build	2016-09-16 03:47:53 +00:00
README.txt	…
TestingLibcxx.rst	Update TestingLibcxx doc to reflect the use_system_cxx_lib flag. Patch from Michael Park	2016-12-23 19:09:14 +00:00
UsingLibcxx.rst	Implement a throwing version of _LIBCPP_ASSERT.	2016-12-28 04:58:52 +00:00
conf.py	Update year to 2017	2017-01-03 11:20:43 +00:00
index.rst	[libc++] Cleanup and document <__threading_support>	2017-01-06 20:05:40 +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.