llvm-project/libcxx/docs
Louis Dionne a276f45180 [libc++][docs] Update documentation to reflect libc++'s compiler support policy
In https://lists.llvm.org/pipermail/llvm-dev/2021-March/148881.html, we
discussed updating the compiler support policy for libc++ to match more
closely what we do actually support.

This commit enshrines that policy decision in libc++'s documentation.

Differential Revision: https://reviews.llvm.org/D105563
2021-07-08 11:56:50 -04:00
..
DesignDocs [libc++] Update ABI docs. NFCI. 2021-06-29 12:39:23 -04:00
Helpers [libc++] [docs] Exclude helper files from Sphinx configuration to avoid generating empty pages. 2020-11-27 13:47:20 +01:00
Status [libc++] NFC: Move the status docs to their own subdirectory 2021-07-06 09:48:34 -04:00
AddingNewCIJobs.rst [libc++] Clean up scripts to setup CI on macOS 2021-06-14 15:55:36 -04:00
BuildingLibcxx.rst [libc++][docs] Overhaul the documentation for building and using libc++ 2021-07-06 14:09:14 -04:00
CMakeLists.txt
Contributing.rst [libc++] Update contributor documentation. 2021-04-07 18:33:27 +02:00
FeatureTestMacroTable.rst [libcxx] Implement P0883R2 ("Fixing Atomic Initialization") 2021-06-20 17:37:42 +03:00
Makefile.sphinx Add design docs for upcoming file_time_type change. 2018-07-25 02:53:53 +00: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++abi] Remove the LIBCXXABI_ENABLE_PIC option 2021-06-10 12:26:31 -04:00
TestingLibcxx.rst [libc++] Move handling of the target triple to the DSL 2021-05-08 11:10:53 -04:00
UsingLibcxx.rst [libc++][docs] Overhaul the documentation for building and using libc++ 2021-07-06 14:09:14 -04:00
conf.py [docs] Automatically update copyright year in libc++. 2021-05-03 18:46:13 +02:00
index.rst [libc++][docs] Update documentation to reflect libc++'s compiler support policy 2021-07-08 11:56:50 -04: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.