llvm-project/libcxx/docs
varconst 2c5a548b53 [libc++][ranges][NFC] Revamp the Ranges status page
Focus on the not-yet-implemented features: remove most details about the
already-implemented C++20 stuff, list out the major C++23 additions.

Differential Revision: https://reviews.llvm.org/D136657
2022-11-29 14:40:35 -08:00
..
DesignDocs [libc++] Start classifying debug mode features with more granularity 2022-11-15 11:18:22 -05:00
Helpers [libc++][doc] Use issue labels. 2021-10-15 17:30:33 +02:00
Status [libc++][ranges][NFC] Revamp the Ranges status page 2022-11-29 14:40:35 -08:00
AddingNewCIJobs.rst [libcxx] Add BOT_OWNERS.txt 2022-11-22 15:41:23 +00:00
BuildingLibcxx.rst [CMake] Use LLVM_TARGET_TRIPLE in runtimes 2022-11-29 04:08:24 +00:00
CMakeLists.txt
Contributing.rst [libc++] Documents details of the pre-commit CI. 2022-11-10 20:20:17 +01:00
FeatureTestMacroTable.rst [libc++] Add FTM for constexpr vector 2022-11-09 22:45:20 +01:00
README.txt [libc++] NFC: Add note about how the libcxx website gets updated 2021-07-05 10:25:33 -04:00
ReleaseNotes.rst [lbc++] Implement the rest of P0600R1 (nodiscard in the library) 2022-11-29 19:42:38 +01:00
TestingLibcxx.rst [libc++] Add a bunch of missing _LIBCPP_HIDE_FROM_ABI 2022-08-13 22:41:22 +02:00
UsingLibcxx.rst [libcxx] adds an include-what-you-use (IWYU) mapping file 2022-11-22 01:09:49 +00:00
conf.py Bump the trunk major version to 16 2022-07-26 21:34:45 -07:00
index.rst [libc++] Bump AppleClang compiler requirement 2022-11-25 09:51:44 -05: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.