llvm-capstone/libcxx/docs
2022-03-27 17:14:27 +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++][doc] Update format implementation status. 2022-03-27 17:14:27 +02:00
AddingNewCIJobs.rst [libc++] Add timeout to BuildKite jobs 2021-08-09 15:31:04 -04:00
BuildingLibcxx.rst [libc++] Add a lightweight overridable assertion handler 2022-03-23 15:35:46 -04: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 Replace links to archived mailing lists by links to Discourse forums 2022-03-23 10:10:20 -04: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++] Add a lightweight overridable assertion handler 2022-03-23 15:35:46 -04:00
TestingLibcxx.rst [libc++][Docs] Update benchmark doc wrt monorepo 2021-10-02 07:35:32 +05:30
UsingLibcxx.rst [libc++] Add a lightweight overridable assertion handler 2022-03-23 15:35:46 -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.