hanchenye-llvm-project

History

Shoaib Meenai fc6100c195 [libc++] Add _LIBCPP_DISABLE_VISIBILITY_ANNOTATIONS It's useful to be able to disable visibility annotations entirely; for example, if we're building libc++ static to include in another library, and we don't want any libc++ functions getting exported out of that library. This is a generalization of _LIBCPP_DISABLE_DLL_IMPORT_EXPORT. Differential Revision: https://reviews.llvm.org/D26934 llvm-svn: 288690		2016-12-05 19:40:12 +00:00
..
DesignDocs	[libc++] Introduce `_LIBCPP_OVERRIDABLE_FUNC_VIS`	2016-11-16 22:18:10 +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	[libc++] Add _LIBCPP_DISABLE_VISIBILITY_ANNOTATIONS	2016-12-05 19:40:12 +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.