llvm-project/libcxx/docs
zoecarver 6a328c66d3 [libc++] shared_ptr deleter requirements (LWG 2802).
This patch implements 2802. Requires _Deleter to have call operator and be move constructible. Based on D62233.

Refs PR37637.

Differential Revision: https://reviews.llvm.org/D62274
2021-02-18 21:31:07 -08: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 libcxx: fix a documentation typo 2021-02-18 11:59:51 -05:00
CMakeLists.txt docs: Fix Sphinx detection with out-of-tree builds 2017-05-09 11:18:03 +00:00
Contributing.rst [libc++] NFC: Document the Differential queries to avoid duplicating work 2021-01-08 17:47:39 -05: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++] shared_ptr deleter requirements (LWG 2802). 2021-02-18 21:31:07 -08:00
Cxx1zStatusPaperStatus.csv [libc++] [docs] Migrate C++ status pages to RestructuredText (RST). 2020-11-26 10:01:09 +01:00
Cxx2aStatus.rst [libc++] [P0202] constexpr set_union, set_difference, set_symmetric_difference, merge 2020-12-04 17:53:54 -05:00
Cxx2aStatusIssuesStatus.csv [libc++] [LWG2993] reference_wrapper<T> conversion from U&& 2021-02-09 15:50:25 -05:00
Cxx2aStatusPaperStatus.csv [libc++] [P0879] constexpr std::sort 2021-02-03 18:57:05 -05:00
Cxx2bStatus.rst [libc++] [docs] Add C++2b (to be C++23) status page. 2020-12-03 09:22:06 +01:00
Cxx2bStatusPaperStatus.csv [NFC][libc++] Update the implementation status. 2021-01-22 20:24:33 +01:00
FeatureTestMacroTable.rst [libc++] Mark __cpp_lib_constexpr_memory as being implemented 2021-02-15 15:26:53 -05: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++] Rename check-cxx-deps to cxx-test-depends for consistency 2021-01-18 14:41:53 -05: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.