llvm-project/libcxx/docs
Louis Dionne 647fb6b374 [libc++] Update the <version> header in-place from generate_feature_test_macro_components
This simplifies the workflow for adding new feature-test macros for
contributors. Previously, they would have to move the generated <version>
header from a temporary directory to libc++'s include directory by hand.
This makes the behavior for the <version> header consistent with what's
done for the tests and the documentation.
2020-10-13 09:18:35 -04:00
..
DesignDocs [libc++] Update the <version> header in-place from generate_feature_test_macro_components 2020-10-13 09:18:35 -04:00
BuildingLibcxx.rst [libc++] Provide a default LLVM_PATH when building standalone 2020-06-29 12:40:07 -04:00
CMakeLists.txt docs: Fix Sphinx detection with out-of-tree builds 2017-05-09 11:18:03 +00:00
FeatureTestMacroTable.rst [libc++] Implement C++20's P0784 (More constexpr containers) 2020-09-22 11:20:33 -04: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 12 2020-07-15 12:05:05 +02:00
TestingLibcxx.rst [libc++] Move the default site config template alongside other config files 2020-08-29 17:14:20 -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 12 2020-07-15 12:05:05 +02:00
index.rst Reland [libcxx]Put clang::trivial_abi on smart pointers 2020-07-20 11:54:34 -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.