llvm-project/libcxx/docs
Louis Dionne 8508b1c133 [libc++] Divorce the std Lit feature from the -std=XXX compiler flag
After this patch, we can use `--param std=c++20` even if the compiler only
supports -std=c++2a. The test suite will handle that for us. The only Lit
feature that isn't fully baked will always be the "in development" one,
since we don't know exactly what year the standard will be ratified in.

This is another take on https://reviews.llvm.org/D99789.

Differential Revision: https://reviews.llvm.org/D100210
2021-04-12 11:55:39 -04:00
..
DesignDocs [lic++][docs] Explain noexcept policy for narrow contracts. 2021-02-05 11:27:19 -08:00
Helpers [libc++] [docs] Exclude helper files from Sphinx configuration to avoid generating empty pages. 2020-11-27 13:47:20 +01:00
AddingNewCIJobs.rst [libc++] Add documentation for setting up new CI jobs 2020-11-19 14:42:02 -05:00
BuildingLibcxx.rst [CMake] Remove {LIBCXX,LIBCXXABI,LIBUNWIND}_INSTALL_PREFIX 2021-04-01 10:13:07 -07:00
CMakeLists.txt
Contributing.rst [libc++] Update contributor documentation. 2021-04-07 18:33:27 +02:00
Cxx1yStatus.rst [libc++] [docs] Add C++2b (to be C++23) status page. 2020-12-03 09:22:06 +01:00
Cxx1yStatusIssuesStatus.csv [libc++] [docs] Migrate C++ status pages to RestructuredText (RST). 2020-11-26 10:01:09 +01:00
Cxx1yStatusPaperStatus.csv [libc++] [docs] Migrate C++ status pages to RestructuredText (RST). 2020-11-26 10:01:09 +01:00
Cxx1zStatus.rst [libc++] [docs] Add C++2b (to be C++23) status page. 2020-12-03 09:22:06 +01:00
Cxx1zStatusIssuesStatus.csv [libc++][nfc] SFINAE on pair/tuple assignment operators: LWG 2729. 2021-02-19 13:25:34 -08:00
Cxx1zStatusPaperStatus.csv [libc++] [docs] Migrate C++ status pages to RestructuredText (RST). 2020-11-26 10:01:09 +01:00
Cxx2aStatus.rst [libc++] [docs] Add link to clang status page for C++2b and fix anchor for C++20. 2021-03-11 20:49:14 +01:00
Cxx2aStatusIssuesStatus.csv [libcxx] adds __cpp_lib_concepts feature-test macro 2021-04-07 16:14:45 +00:00
Cxx2aStatusPaperStatus.csv [libcxx] adds __cpp_lib_concepts feature-test macro 2021-04-07 16:14:45 +00:00
Cxx2bStatus.rst [libc++] [docs] Add link to clang status page for C++2b and fix anchor for C++20. 2021-03-11 20:49:14 +01:00
Cxx2bStatusIssuesStatus.csv [libc++] [docs] [C++2b] Update status page with issues (and forgotten papers) adopted in November 2020 and February 2021 virtual meetings. 2021-03-01 11:19:18 +01:00
Cxx2bStatusPaperStatus.csv [libc++] [C++2b] [P2162] Allow inheritance from std::variant. 2021-03-25 18:20:50 +01:00
FeatureTestMacroTable.rst [libcxx] adds __cpp_lib_concepts feature-test macro 2021-04-07 16:14:45 +00:00
Makefile.sphinx Add design docs for upcoming file_time_type change. 2018-07-25 02:53:53 +00:00
README.txt
ReleaseNotes.rst Revert "[libc++] Require C++20 to build the benchmarks." 2021-02-09 19:59:34 +01:00
TestingLibcxx.rst [libc++] Divorce the std Lit feature from the -std=XXX compiler flag 2021-04-12 11:55:39 -04:00
UsingLibcxx.rst [libc++] Use c++20 instead of c++2a consistently. 2021-01-07 13:11:33 +01:00
conf.py Bump the trunk major version to 13 2021-01-26 19:37:55 -08:00
index.rst [lic++][docs] Explain noexcept policy for narrow contracts. 2021-02-05 11:27:19 -08: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.