llvm/libcxx/docs
2021-06-03 15:49:41 -04:00
..
DesignDocs [libc++] [LIBCXX-DEBUG-FIXME] Our __debug_less breaks some complexity guarantees. 2021-05-05 16:21:09 -04:00
Helpers
AddingNewCIJobs.rst
BuildingLibcxx.rst [libcxx] Update docs regarding the need for bash/posix tools for tests on Windows. NFC. 2021-05-04 22:13:08 +03:00
CMakeLists.txt
conf.py [docs] Automatically update copyright year in libc++. 2021-05-03 18:46:13 +02:00
Contributing.rst [libc++] Update contributor documentation. 2021-04-07 18:33:27 +02:00
Cxx1yStatus.rst
Cxx1yStatusIssuesStatus.csv
Cxx1yStatusPaperStatus.csv
Cxx1zStatus.rst
Cxx1zStatusIssuesStatus.csv [libc++] Fix LWG 2874: Constructor shared_ptr::shared_ptr(Y*) should be constrained. 2021-04-16 09:54:20 -04:00
Cxx1zStatusPaperStatus.csv
Cxx2aStatus.rst [libc++] [P0619] Hide not1 and not2 under _LIBCPP_ENABLE_CXX20_REMOVED_NEGATORS. 2021-05-25 16:57:16 -04:00
Cxx2aStatusIssuesStatus.csv [libc++][doc] Update format paper status. 2021-05-24 16:48:44 +02:00
Cxx2aStatusPaperStatus.csv [libc++] [C++20] [P0586] Implement safe integral comparisons 2021-04-20 04:52:59 +05:30
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++] Implement LWG3435 (constraints on reverse_iterator and move_iterator) 2021-06-03 15:49:41 -04:00
Cxx2bStatusPaperStatus.csv [libc++] [C++2b] [P2162] Allow inheritance from std::variant. 2021-03-25 18:20:50 +01:00
FeatureTestMacroTable.rst [libc++] [C++20] [P0586] Implement safe integral comparisons 2021-04-20 04:52:59 +05:30
FormatIssuePaperStatus.csv [libc++][doc] Update format paper status. 2021-05-24 16:48:44 +02:00
FormatProposalStatus.csv [libc++][doc] Update the Format library status. 2021-05-09 17:55:50 +02:00
FormatStatus.rst [libc++][doc] Adds a Format library status page. 2021-04-24 16:38:18 +02:00
index.rst [libc++][doc] Adds a Format library status page. 2021-04-24 16:38:18 +02:00
Makefile.sphinx
OneRangesProposalStatus.csv [libcxx][ranges] Add default_sentinel and default_sentinel_t. 2021-06-01 14:03:54 -07:00
RangesIssuePaperStatus.csv [libc++][docs] Add status docs for ranges. 2021-04-13 17:59:42 -07:00
RangesStatus.rst [NFC][libc++] Fixes a documentation typo. 2021-04-14 19:33:03 +02:00
README.txt
ReleaseNotes.rst [libc++] Disentangle std::pointer_safety 2021-05-03 14:33:49 -04:00
TestingLibcxx.rst [libc++] Move handling of the target triple to the DSL 2021-05-08 11:10:53 -04:00
UsingLibcxx.rst [libc++] [P0619] Hide not1 and not2 under _LIBCPP_ENABLE_CXX20_REMOVED_NEGATORS. 2021-05-25 16:57:16 -04: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.