darling-libcxx/docs
2017-02-17 03:30:25 +00:00
..
DesignDocs Fix typo in docs 2017-02-05 01:16:25 +00:00
BuildingLibcxx.rst docs: add some documentation for building on Windows 2017-02-10 03:58:20 +00:00
CMakeLists.txt [libcxx] Add new Sphinx documentation 2015-08-22 19:40:49 +00:00
conf.py Update version to 5.0 2017-01-13 18:29:56 +00:00
index.rst [libcxx] Mentions "targeting C++11 and above" instead of "targeting C++11" in the doc 2017-01-25 17:00:30 +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 Update TestingLibcxx doc to reflect the use_system_cxx_lib flag. Patch from Michael Park 2016-12-23 19:09:14 +00:00
UsingLibcxx.rst Add doc for _LIBCPP_ENABLE_CXX17_DISABLED_AUTO_PTR and make it work under _LIBCPP_ENABLE_CXX17_REMOVED_FEATURES 2017-02-17 03:30:25 +00:00

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.