llvm-project

History

Eric Fiselier efd48ca568 Add docs for use-configurable libc++ features llvm-svn: 286784		2016-11-13 23:00:30 +00:00
..
DesignDocs	Fix _LIBCPP_EXTERN_TEMPLATE_INLINE_VISIBILITY to always have default visibility.	2016-10-31 02:07:23 +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	Remove test commit.	2015-09-05 05:38:50 +00:00
TestingLibcxx.rst	Cleanup LIT testing doc	2016-10-14 06:15:27 +00:00
UsingLibcxx.rst	Add docs for use-configurable libc++ features	2016-11-13 23:00:30 +00:00
conf.py	Update version numbers in docs	2016-05-03 22:50:33 +00:00
index.rst	[libc++] Fix and document visibility attributes for Clang, GCC and Windows.	2016-09-15 22:27:07 +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.