llvm-project/libcxx/docs
Louis Dionne 7300a651f5 [libc++] Re-apply "Always build c++experimental.a""
This re-applies bb939931a1, which had been reverted by 09cebfb978
because it broke Chromium. The issues seen by Chromium should be
addressed by 1d0f79558c.

Differential Revision: https://reviews.llvm.org/D128927
2022-07-19 10:44:19 -04:00
..
DesignDocs [libc++] Re-apply the use of ABI tags to provide per-TU insulation 2022-07-08 08:38:36 -04:00
Helpers [libc++][doc] Use issue labels. 2021-10-15 17:30:33 +02:00
Status [libc++][ranges] Implement `ranges::{,stable_}partition`. 2022-07-18 21:06:17 -07:00
AddingNewCIJobs.rst [libc++] Add timeout to BuildKite jobs 2021-08-09 15:31:04 -04:00
BuildingLibcxx.rst [libc++] Re-apply "Always build c++experimental.a"" 2022-07-19 10:44:19 -04:00
CMakeLists.txt
Contributing.rst [libc++] Fix modules builds when features are removed 2022-06-08 18:48:25 -04:00
FeatureTestMacroTable.rst [libc++] Implement P0154R1 (Hardware inference size) 2022-06-23 01:31:09 +02: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++] Undeprecate ATOMIC_FLAG_INIT (LWG3659) 2022-07-12 08:00:40 +03:00
TestingLibcxx.rst [libc++] Make the Debug mode a configuration-time only option 2022-06-07 16:33:53 -04:00
UsingLibcxx.rst [libc++] Re-apply "Always build c++experimental.a"" 2022-07-19 10:44:19 -04:00
conf.py Bump the trunk major version to 15 2022-02-01 23:54:52 -08:00
index.rst [libc++][CI] Updates GCC to version 12. 2022-06-21 18:59:20 +02: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.