bolt/deps/llvm-18.1.8/libcxx/docs
2025-02-14 19:21:04 +01:00
..
DesignDocs Embed LLVM 18.1.8 2025-02-14 19:21:04 +01:00
Helpers Embed LLVM 18.1.8 2025-02-14 19:21:04 +01:00
ReleaseNotes Embed LLVM 18.1.8 2025-02-14 19:21:04 +01:00
Status Embed LLVM 18.1.8 2025-02-14 19:21:04 +01:00
AddingNewCIJobs.rst Embed LLVM 18.1.8 2025-02-14 19:21:04 +01:00
BuildingLibcxx.rst Embed LLVM 18.1.8 2025-02-14 19:21:04 +01:00
CMakeLists.txt Embed LLVM 18.1.8 2025-02-14 19:21:04 +01:00
conf.py Embed LLVM 18.1.8 2025-02-14 19:21:04 +01:00
Contributing.rst Embed LLVM 18.1.8 2025-02-14 19:21:04 +01:00
FeatureTestMacroTable.rst Embed LLVM 18.1.8 2025-02-14 19:21:04 +01:00
Hardening.rst Embed LLVM 18.1.8 2025-02-14 19:21:04 +01:00
ImplementationDefinedBehavior.rst Embed LLVM 18.1.8 2025-02-14 19:21:04 +01:00
index.rst Embed LLVM 18.1.8 2025-02-14 19:21:04 +01:00
Modules.rst Embed LLVM 18.1.8 2025-02-14 19:21:04 +01:00
README.txt Embed LLVM 18.1.8 2025-02-14 19:21:04 +01:00
ReleaseNotes.rst Embed LLVM 18.1.8 2025-02-14 19:21:04 +01:00
ReleaseProcedure.rst Embed LLVM 18.1.8 2025-02-14 19:21:04 +01:00
TestingLibcxx.rst Embed LLVM 18.1.8 2025-02-14 19:21:04 +01:00
UsingLibcxx.rst Embed LLVM 18.1.8 2025-02-14 19:21:04 +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.