llvm-project/libcxx/docs
Nikolas Klauser 2e2f3158c6 [libc++] Granularize algorithm includes
Reviewed By: Mordante, ldionne, Quuxplusone, #libc, #libc_abi

Spies: #libc_vendors, libcxx-commits, miyuki

Differential Revision: https://reviews.llvm.org/D119667
2022-02-16 04:12:22 +01: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 Ranges changes to `istream{,buf}_iterator`. 2022-02-15 16:59:42 -08:00
AddingNewCIJobs.rst [libc++] Add timeout to BuildKite jobs 2021-08-09 15:31:04 -04:00
BuildingLibcxx.rst Update all LLVM documentation mentioning runtimes in LLVM_ENABLE_PROJECTS 2022-02-10 15:05:23 -05:00
CMakeLists.txt
Contributing.rst [libc++] Add documentation about the libc++ review group 2022-01-27 17:06:44 -05:00
FeatureTestMacroTable.rst [libc++] Revert <stdatomic.h> changes 2022-02-15 12:59:14 -05:00
README.txt [libc++] NFC: Add note about how the libcxx website gets updated 2021-07-05 10:25:33 -04:00
ReleaseNotes.rst [libc++] Granularize algorithm includes 2022-02-16 04:12:22 +01:00
TestingLibcxx.rst [libc++][Docs] Update benchmark doc wrt monorepo 2021-10-02 07:35:32 +05:30
UsingLibcxx.rst [libc++] Implement C++20's P0476R2: std::bit_cast 2021-09-09 11:05:54 -04:00
conf.py Bump the trunk major version to 15 2022-02-01 23:54:52 -08:00
index.rst [libc++] Add Status page for P2321R2 (Zip) 2022-01-11 23:13:31 +01:00

README.txt

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.