llvm-project/libcxx/docs
Louis Dionne 90455dbe2e [libc++] NFC: Add documentation for writing tests 2020-04-02 17:14:45 -04:00
..
DesignDocs Add documentation and tests for Clangs C++11 extensions in C++03. 2019-06-11 22:53:49 +00:00
BuildingLibcxx.rst [libc++] Fix wrong default value for LIBCXX_ENABLE_ASSERTIONS in documentation 2020-03-30 12:44:57 -04:00
CMakeLists.txt docs: Fix Sphinx detection with out-of-tree builds 2017-05-09 11:18:03 +00:00
FeatureTestMacroTable.rst [libc++] [P0646] Add feature-test macro for __cpp_lib_list_remove_return_type. 2020-03-12 11:06:49 +01:00
Makefile.sphinx Add design docs for upcoming file_time_type change. 2018-07-25 02:53:53 +00:00
README.txt
ReleaseNotes.rst Bump the trunk major version to 11 2020-01-15 13:38:01 +01:00
TestingLibcxx.rst [libc++] NFC: Add documentation for writing tests 2020-04-02 17:14:45 -04:00
UsingLibcxx.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
conf.py Bump the trunk major version to 11 2020-01-15 13:38:01 +01:00
index.rst [libc++] Bump Clang support for Clang 4 2020-03-23 12:17:04 -04: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.