llvm/libcxx/docs
Louis Dionne 3ee0cec88e [runtimes] Remove FOO_TARGET_TRIPLE, FOO_SYSROOT and FOO_GCC_TOOLCHAIN
Instead, folks can use the equivalent variables provided by CMake
to set those. This removal aims to reduce complexity and potential
for confusion when setting the target triple for building the runtimes,
and make it correct when `CMAKE_OSX_ARCHITECTURES` is used (right now
both `-arch` and `--target=` will end up being passed, which is downright
incorrect).

Differential Revision: https://reviews.llvm.org/D112155
2022-03-01 08:39:42 -05:00
..
DesignDocs [libc++][docs] Change some words to use reST inline literals 2022-02-07 10:00:42 -08:00
Helpers [libc++][doc] Use issue labels. 2021-10-15 17:30:33 +02:00
Status [libc++][ranges] Implement std::sortable. 2022-02-17 20:17:42 -08:00
AddingNewCIJobs.rst
BuildingLibcxx.rst [runtimes] Remove FOO_TARGET_TRIPLE, FOO_SYSROOT and FOO_GCC_TOOLCHAIN 2022-03-01 08:39:42 -05:00
CMakeLists.txt
conf.py Bump the trunk major version to 15 2022-02-01 23:54:52 -08:00
Contributing.rst [libc++abi] Bump the libc++abi version and add it to the post-release list 2022-02-16 16:27:25 -05:00
FeatureTestMacroTable.rst [libc++] Revert <stdatomic.h> changes 2022-02-15 12:59:14 -05:00
index.rst [libc++] Add Status page for P2321R2 (Zip) 2022-01-11 23:13:31 +01:00
README.txt
ReleaseNotes.rst [runtimes] Remove FOO_TARGET_TRIPLE, FOO_SYSROOT and FOO_GCC_TOOLCHAIN 2022-03-01 08:39:42 -05:00
TestingLibcxx.rst
UsingLibcxx.rst

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.