llvm-capstone/libcxx/docs
Martin Storsjö 06322d43d5
[libcxx] [docs] Remove mention of a MSVC/Debug mode caveat (#68791)
Since e346fd8a60 and
cd1b8be8de, the tests should run fine in
Debug mode, with failed asserts not popping up blocking dialog boxes.
2023-10-11 06:32:45 -07: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++][hardening] Undeprecate safe mode (#68391) 2023-10-10 11:10:18 -07:00
Status [libc++] LWG 3821 uses_allocator_construction_args should have overload for pair-like (#66939) 2023-10-09 13:50:27 +01:00
AddingNewCIJobs.rst [libc++][NFC] Fix typo in documentation 2023-03-02 12:42:15 -05:00
BuildingLibcxx.rst [libcxx] [docs] Remove mention of a MSVC/Debug mode caveat (#68791) 2023-10-11 06:32:45 -07: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++] Implement std::condition_variable_any::wait[_for/until] overloads that take stop_token 2023-09-29 13:50:16 +01: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++] Remove the CI job testing Clang 15 (#66406) 2023-09-25 17:55:59 -04: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 [libcxx] Allow string to use SSO in constant evaluation. (#66576) 2023-10-10 11:31:47 -07: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.