llvm-project/libcxx/docs
Louis Dionne a65dc08d10 [libc++] Implement missing feature-test macro __cpp_lib_shared_ptr_arrays
This was forgotten when we implemented support for arrays in std::shared_ptr
in https://reviews.llvm.org/D62259.
2020-12-08 15:46:45 -05:00
..
DesignDocs [libc++] Rework the whole availability markup implementation 2020-11-05 12:28:52 -05: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 [libc++] Clarify how we pick the typeinfo comparison 2020-11-18 16:58:45 -05:00
CMakeLists.txt
Contributing.rst [libc++] [docs] Update and move NOTES.txt to docs/Contributing.rst. 2020-12-02 08:54:11 +01: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++] [docs] Add Version column to issues tables on status pages. 2020-12-04 18:44:35 +01: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++] [LWG3221] Add tests for wrapping operator+(year_month, months). 2020-12-08 18:08:04 +01:00
Cxx2aStatusPaperStatus.csv [libc++] [docs] Mark P1865 as complete since 11.0 as it was implemented together with P1135. Fix synopses in <barrier> and <latch>. 2020-12-06 15:36:52 +01:00
Cxx2bStatus.rst [libc++] [docs] Add C++2b (to be C++23) status page. 2020-12-03 09:22:06 +01:00
Cxx2bStatusPaperStatus.csv [libc++] [docs] Add C++2b (to be C++23) status page. 2020-12-03 09:22:06 +01:00
FeatureTestMacroTable.rst [libc++] Implement missing feature-test macro __cpp_lib_shared_ptr_arrays 2020-12-08 15:46:45 -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 [libcxx] Implement c++2a char8_t input/output of std::filesystem::path 2020-12-04 11:37:05 +02:00
TestingLibcxx.rst [libc++] Migrate warning flags to the DSL 2020-11-02 12:25:05 -05:00
UsingLibcxx.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
conf.py [libc++] [docs] Exclude helper files from Sphinx configuration to avoid generating empty pages. 2020-11-27 13:47:20 +01:00
index.rst [libc++] [docs] Add C++2b (to be C++23) status page. 2020-12-03 09:22:06 +01: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.