llvm/libcxx/docs
2022-02-04 11:58:35 -08:00
..
DesignDocs [libcxx][doc][nfc] Fixed typo in doc 2022-01-21 10:17:28 -05:00
Helpers [libc++][doc] Use issue labels. 2021-10-15 17:30:33 +02:00
Status [libc++][ranges][NFC] On the Ranges status page, fix some broken links. 2022-02-04 11:58:35 -08:00
AddingNewCIJobs.rst
BuildingLibcxx.rst [runtimes] Remove support for GCC-style 32 bit multilib builds 2021-12-01 12:57:01 -05:00
CMakeLists.txt
conf.py Bump the trunk major version to 15 2022-02-01 23:54:52 -08:00
Contributing.rst [libc++] Add documentation about the libc++ review group 2022-01-27 17:06:44 -05:00
FeatureTestMacroTable.rst [libc++] Implement P1072R10 (std::basic_string::resize_and_overwrite) 2022-01-07 00:09:16 +01:00
index.rst [libc++] Add Status page for P2321R2 (Zip) 2022-01-11 23:13:31 +01:00
README.txt
ReleaseNotes.rst Bump the trunk major version to 15 2022-02-01 23:54:52 -08:00
TestingLibcxx.rst [libc++][Docs] Update benchmark doc wrt monorepo 2021-10-02 07:35:32 +05:30
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.