llvm-project

History

Eric Fiselier c79795874a Add Filesystem TS -- Complete Add the completed std::experimental::filesystem implementation and tests. The implementation supports C++11 or newer. The TS is built as part of 'libc++experimental.a'. Users of the TS need to manually link this library. Building and testing the TS can be disabled using the CMake option '-DLIBCXX_ENABLE_FILESYSTEM=OFF'. Currently 'libc++experimental.a' is not installed by default. To turn on the installation of the library use '-DLIBCXX_INSTALL_EXPERIMENTAL_LIBRARY=ON'. llvm-svn: 273034		2016-06-17 19:46:40 +00:00
..
DesignDocs	Use __config_site when building libc++. Also cleanup ABI versioning doc	2015-10-14 00:22:05 +00:00
BuildingLibcxx.rst	Add Filesystem TS -- Complete	2016-06-17 19:46:40 +00:00
CMakeLists.txt	…
Makefile.sphinx	Test commit for builder	2015-09-05 05:29:23 +00:00
README.txt	Remove test commit.	2015-09-05 05:38:50 +00:00
TestingLibcxx.rst	Fix sphinx build. This is a temporary solution.	2016-05-05 08:12:25 +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	Add links to libc++ code coverage and builders	2015-10-15 03:27:02 +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.