llvm-project/libcxx/docs
Mark de Wever 24e1736d84 [libc++][random] Removes transitive includes.
It seems these includes are still provided by the sub headers, so it only
removes the duplicates.

There is no change in the list of includes, but the change affects the
modular build. By not having the includes in the top-level header the
module map has changed. This uncovers missing includes in the tests
and missing exports in the module map. This causes the huge amount of
changes in the patch.

Reviewed By: #libc, ldionne

Differential Revision: https://reviews.llvm.org/D133252
2022-09-11 17:39:27 +02:00
..
DesignDocs [libc++] Reduces the number of transitive includes. 2022-08-31 19:50:03 +02:00
Helpers [libc++][doc] Use issue labels. 2021-10-15 17:30:33 +02:00
Status [libc++][doc] Updates format status page. 2022-09-11 12:12:22 +02:00
AddingNewCIJobs.rst [libc++] Add timeout to BuildKite jobs 2021-08-09 15:31:04 -04:00
BuildingLibcxx.rst Revert "[cmake] Use `CMAKE_INSTALL_LIBDIR` too" 2022-08-18 22:46:32 -04:00
CMakeLists.txt
Contributing.rst [libc++] Treat incomplete features just like other experimental features 2022-07-19 10:50:20 -04:00
FeatureTestMacroTable.rst [libc++][format] Updates feature-test macros. 2022-09-07 18:39:39 +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++][random] Removes transitive includes. 2022-09-11 17:39:27 +02:00
TestingLibcxx.rst [libc++] Add a bunch of missing _LIBCPP_HIDE_FROM_ABI 2022-08-13 22:41:22 +02:00
UsingLibcxx.rst [libc++] Enable [[nodiscard]] extensions by default 2022-09-02 21:34:20 +02:00
conf.py Bump the trunk major version to 16 2022-07-26 21:34:45 -07:00
index.rst [libc++] Removes Clang 13 support. 2022-09-08 17:51:52 +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.