llvm-capstone/libcxx/docs
2023-09-16 19:54:19 +01:00
..
DesignDocs [libc++][chrono] Adds tzdb_list implementation. 2023-09-06 20:48:07 +02:00
Helpers [libc++] Encode the version in the ReleaseNotes file 2023-07-18 14:06:21 -04:00
ReleaseNotes [libc++] Implement P2538R1 "ADL-proof std::projected" (#65411) 2023-09-15 10:09:38 -04:00
Status [libc++] Implement P2538R1 "ADL-proof std::projected" (#65411) 2023-09-15 10:09:38 -04:00
AddingNewCIJobs.rst [libc++][NFC] Fix typo in documentation 2023-03-02 12:42:15 -05:00
BuildingLibcxx.rst [libc++][doc] Add warning about limitation of --fresh in boostrapping build (#65265) 2023-09-07 13:22:07 -04:00
CMakeLists.txt
conf.py [NFC][Py Reformat] Reformat python files in libcxx/libcxxabi 2023-05-25 11:15:34 +02:00
Contributing.rst [libc++][doc] Improves contribution page. 2023-08-29 19:05:31 +02:00
FeatureTestMacroTable.rst [libc++][ranges] Implement P2443R1: views::chunk_by 2023-09-05 16:19:49 -07:00
Hardening.rst [libc++][hardening] Add back the safe mode. 2023-09-12 12:01:51 -07:00
ImplementationDefinedBehavior.rst [libc++][chrono] Adds tzdb_list implementation. 2023-09-06 20:48:07 +02:00
index.rst [libc++][chrono] Adds tzdb_list implementation. 2023-09-06 20:48:07 +02:00
Modules.rst [libc++][C++20 modules] Tests no experimental library build. 2023-09-06 19:31:29 +02:00
README.txt [libc++] NFC: Add note about how the libcxx website gets updated 2021-07-05 10:25:33 -04:00
ReleaseProcedure.rst [libc++] Encode the version in the ReleaseNotes file 2023-07-18 14:06:21 -04:00
TestingLibcxx.rst [libc] Fix typos in documentation 2023-05-22 23:25:16 -07:00
UsingLibcxx.rst [libc++] implement std::jthread 2023-09-16 19:54:19 +01: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.

The documentation in this directory is published at https://libcxx.llvm.org. It is kept up-to-date
by a build bot: https://lab.llvm.org/buildbot/#/builders/publish-sphinx-docs. If you notice that the
documentation is not updating anymore, please contact one of the maintainers.