llvm-capstone/libcxx/docs
Nikolas Klauser 75f6af82c3 [libc++] Mark LWG2994 as complete and remove Clang from the version
Reviewed By: #libc, ldionne

Spies: ldionne, libcxx-commits

Differential Revision: https://reviews.llvm.org/D154381
2023-07-05 14:43:04 -07:00
..
DesignDocs [libc++] Remove the legacy debug mode. 2023-06-29 14:49:51 -07:00
Helpers
Status [libc++] Mark LWG2994 as complete and remove Clang from the version 2023-07-05 14:43:04 -07:00
AddingNewCIJobs.rst
BuildingLibcxx.rst [libc] Fix typos in documentation 2023-05-22 23:25:16 -07:00
CMakeLists.txt
conf.py [NFC][Py Reformat] Reformat python files in libcxx/libcxxabi 2023-05-25 11:15:34 +02:00
Contributing.rst [libc++][modules] Adds the C++23 std module. 2023-06-15 18:14:15 +02:00
FeatureTestMacroTable.rst [libc++][ranges] Implement P2494R2 (Relaxing range adaptors to allow for move only types) 2023-06-25 08:15:52 +08:00
index.rst [libc++] Remove the legacy debug mode. 2023-06-29 14:49:51 -07:00
Modules.rst [libc++][doc] Fixes a typo. 2023-06-26 17:09:22 +02:00
README.txt
ReleaseNotes.rst [libc++][format] Implements formatting pointer. 2023-07-05 18:23:31 +02:00
ReleaseProcedure.rst [libc++][doc] Updates the tasks to do for a release. 2023-05-23 19:02:17 +02:00
TestingLibcxx.rst [libc] Fix typos in documentation 2023-05-22 23:25:16 -07:00
UsingLibcxx.rst [libc++][format] Implements formatting pointer. 2023-07-05 18:23:31 +02:00

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.