llvm/libcxx/docs
Louis Dionne 7de5aca84c [libc++] Generalize the customizeable assertion handler
Instead of taking a fixed set of arguments, use variadics so that
we can pass arbitrary arguments to the handler. This is the first
step towards using the handler to handle other non-assertion-related
failures, like std::unreachable and an exception being thrown in
-fno-exceptions mode, which would improve user experience by including
additional information in crashes (right now, we call abort() without
additional information).

Differential Revision: https://reviews.llvm.org/D130507
2022-07-26 07:42:38 -04:00
..
DesignDocs [libc++] Take advantage of -fexperimental-library in libc++ 2022-07-22 08:33:39 -04:00
Helpers
Status [libc++][ranges] Implement ranges::shuffle. 2022-07-22 09:59:13 -07:00
AddingNewCIJobs.rst
BuildingLibcxx.rst [libc++] Treat incomplete features just like other experimental features 2022-07-19 10:50:20 -04:00
CMakeLists.txt
conf.py
Contributing.rst [libc++] Treat incomplete features just like other experimental features 2022-07-19 10:50:20 -04:00
FeatureTestMacroTable.rst [libc++] Implement P1423R3 (char8_t backward compatibility remediation) 2022-07-20 11:27:51 +02:00
index.rst [libc++][CI] Updates GCC to version 12. 2022-06-21 18:59:20 +02:00
README.txt
ReleaseNotes.rst [libc++] Take advantage of -fexperimental-library in libc++ 2022-07-22 08:33:39 -04:00
TestingLibcxx.rst [libc++] Make the Debug mode a configuration-time only option 2022-06-07 16:33:53 -04:00
UsingLibcxx.rst [libc++] Generalize the customizeable assertion handler 2022-07-26 07:42:38 -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.

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.