llvm-project

History

Shoaib Meenai 9f50fffc04 [libc++] Correct explanation of _LIBCPP_NEW_DELETE_VIS The behavior of this macro actually needs to apply universally on Windows and not just when using the Microsoft CRT. Update the macro definition and documentation accordingly. Differential Revision: https://reviews.llvm.org/D25145 llvm-svn: 284016		2016-10-12 13:48:14 +00:00
..
DesignDocs	[libc++] Correct explanation of _LIBCPP_NEW_DELETE_VIS	2016-10-12 13:48:14 +00:00
BuildingLibcxx.rst	Attempt to fix Sphinx build	2016-09-16 03:47:53 +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	Make it easier to run the libc++ test suite against libstdc++	2016-10-12 00:00:37 +00:00
UsingLibcxx.rst	Fix errors in documentation	2016-05-06 04:49: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.