llvm-project/libcxx/docs
Mark de Wever a08554bcdd [libc++][doc] Fixes a broken link. 2021-07-20 19:49:45 +02:00
..
DesignDocs [libc++] Add a bunch of missing _LIBCPP_HIDE_FROM_ABI in <ranges> 2021-07-19 19:33:28 -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++][doc] Fixes a broken link. 2021-07-20 19:49:45 +02:00
AddingNewCIJobs.rst [libc++] Use 'os' tags to target Linux libc++ builders 2021-07-12 17:01:54 -04:00
BuildingLibcxx.rst Prepare Compiler-RT for GnuInstallDirs, matching libcxx, document all 2021-07-13 15:21:41 +00:00
CMakeLists.txt
Contributing.rst [libc++] Add a bunch of missing _LIBCPP_HIDE_FROM_ABI in <ranges> 2021-07-19 19:33:28 -04: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 [libcxx][nfc] Remove <variant>'s dependence on <array>. 2021-07-09 10:13:57 -07: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 [libcxx] [docs] Acknowledge that the library is known to work in some configs outside of what's tested in CI 2021-07-13 23:18:55 +03: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.