llvm-project/libcxx/docs
Brad Smith ed85de6db4 [libcxx] random_device, use arc4random() on Solaris
Reviewed By: ldionne

Differential Revision: https://reviews.llvm.org/D125068
2022-05-07 00:59:12 -04: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++][P0943] Add stdatomic.h header. 2022-05-06 09:52:48 -04:00
AddingNewCIJobs.rst [libc++] Add timeout to BuildKite jobs 2021-08-09 15:31:04 -04:00
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
Contributing.rst [libc++] Remove the __libcpp_version file 2022-03-31 09:34:41 -04:00
FeatureTestMacroTable.rst [libc++][P0943] Add stdatomic.h header. 2022-05-06 09:52:48 -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 [libcxx] random_device, use arc4random() on Solaris 2022-05-07 00:59:12 -04:00
TestingLibcxx.rst [libc++][Docs] Update benchmark doc wrt monorepo 2021-10-02 07:35:32 +05:30
UsingLibcxx.rst [libc++] Ensure that all public C++ headers include <__assert> 2022-03-30 15:05:31 -04:00
conf.py Bump the trunk major version to 15 2022-02-01 23:54:52 -08:00
index.rst [libcxx] [ci] Add a i386 Windows configuration to CI 2022-05-06 10:12:04 +03: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.