llvm-project/libcxx/docs
Louis Dionne 1295694364 [libc++][NFC] Add missing link to a ranges review 2021-09-24 11:37:38 -04:00
..
DesignDocs [libc++] Remove support for CloudABI, which has been abandoned 2021-08-24 14:11:32 -04:00
Helpers [libc++][doc] Cleanup, normalize, and update projects status docs 2021-08-26 10:33:52 -04:00
Status [libc++][NFC] Add missing link to a ranges review 2021-09-24 11:37:38 -04:00
AddingNewCIJobs.rst [libc++] Add timeout to BuildKite jobs 2021-08-09 15:31:04 -04:00
BuildingLibcxx.rst [libcxx][doc] Update the build documentation. 2021-07-29 07:57:10 +02:00
CMakeLists.txt
Contributing.rst [libc++][NFC] Add link to Discord channel from documentation 2021-09-22 11:13:53 -04:00
FeatureTestMacroTable.rst [libc++] Implement C++20's P0476R2: std::bit_cast 2021-09-09 11:05:54 -04: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++][format] Add a CMake Unicode option. 2021-09-04 11:55:10 +02:00
TestingLibcxx.rst [libc++] Move handling of the target triple to the DSL 2021-05-08 11:10:53 -04:00
UsingLibcxx.rst [libc++] Implement C++20's P0476R2: std::bit_cast 2021-09-09 11:05:54 -04:00
conf.py Bump the trunk major version to 14 2021-07-27 21:58:25 -07:00
index.rst [libc++] Revert OpenBSD-related changes to the documentation 2021-09-08 15:55:03 -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.