llvm/libcxx/docs
Nikolas Klauser 1d83750f63 [libc++] Implement ranges::copy{, _n, _if, _backward}
Reviewed By: Mordante, var-const, #libc

Spies: sstefan1, libcxx-commits, mgorny

Differential Revision: https://reviews.llvm.org/D122982
2022-04-15 13:44:11 +02:00
..
DesignDocs [libc++] Correct outdated documentation about __config_site 2022-03-23 13:42:04 -04:00
Helpers [libc++][doc] Use issue labels. 2021-10-15 17:30:33 +02:00
Status [libc++] Implement ranges::copy{, _n, _if, _backward} 2022-04-15 13:44:11 +02:00
AddingNewCIJobs.rst
BuildingLibcxx.rst [libcxx] Stop recommending setting LIBCXX_HAS_WIN32_THREAD_API in the MinGW builds 2022-04-04 23:07:40 +03:00
CMakeLists.txt
conf.py Bump the trunk major version to 15 2022-02-01 23:54:52 -08:00
Contributing.rst [libc++] Remove the __libcpp_version file 2022-03-31 09:34:41 -04:00
FeatureTestMacroTable.rst [libc++] Implement P1007R3: std::assume_aligned 2022-04-11 10:46:52 -04:00
index.rst Replace links to archived mailing lists by links to Discourse forums 2022-03-23 10:10:20 -04:00
README.txt
ReleaseNotes.rst [libc++] Support arrays in make_shared and allocate_shared (P0674R1) 2022-04-06 08:42:55 -04:00
TestingLibcxx.rst
UsingLibcxx.rst [libc++] Ensure that all public C++ headers include <__assert> 2022-03-30 15:05:31 -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.