llvm-project

History

Bruce Mitchener f684c9c83c Fix typos. Reviewers: mclow.lists, EricWF Subscribers: cfe-commits Differential Revision: https://reviews.llvm.org/D43224 llvm-svn: 324989		2018-02-13 08:12:00 +00:00
..
DesignDocs	Fix typos.	2018-02-13 08:12:00 +00:00
BuildingLibcxx.rst	Corrected a typo in the building libc++ docs	2017-12-03 10:18:35 +00:00
CMakeLists.txt	docs: Fix Sphinx detection with out-of-tree builds	2017-05-09 11:18:03 +00:00
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	Teach test suite about C++2a dialect flag.	2017-11-07 20:26:23 +00:00
UsingLibcxx.rst	[libc++] Support Microsoft ABI without vcruntime headers	2017-10-09 19:25:17 +00:00
conf.py	Update version to 7.0.0svn: cmake, include files and docs	2018-01-03 15:40:29 +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.