llvm-capstone/libcxx/docs
2023-08-01 09:40:03 +03:00
..
DesignDocs [libc++] Remove internal "build-with-external-thread-library" configuration 2023-07-17 09:32:36 -04:00
Helpers [libc++] Encode the version in the ReleaseNotes file 2023-07-18 14:06:21 -04:00
ReleaseNotes [libcxx] Add release notes for Windows wide stdio stream handling 2023-08-01 09:40:03 +03:00
Status [libc++][doc] Uses the proper paper number. 2023-07-22 16:44:59 +02:00
AddingNewCIJobs.rst [libc++][NFC] Fix typo in documentation 2023-03-02 12:42:15 -05:00
BuildingLibcxx.rst [libc++][hardening] Deprecate _LIBCPP_ENABLE_ASSERTIONS. 2023-07-14 16:58:47 -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 ranges::to. 2023-07-20 22:48:18 -07:00
Hardening.rst [libc++][hardening][NFC] Rename HardenedMode.rst to Hardening.rst. 2023-07-20 17:41:37 -07:00
index.rst [libc++][doc] Adds LLVM 18.0.0 release nostes. 2023-07-25 19:49:08 +02:00
Modules.rst [libc++][doc] Fixes a typo. 2023-06-26 17:09:22 +02:00
README.txt [libc++] NFC: Add note about how the libcxx website gets updated 2021-07-05 10:25:33 -04:00
ReleaseProcedure.rst [libc++] Encode the version in the ReleaseNotes file 2023-07-18 14:06:21 -04:00
TestingLibcxx.rst [libc] Fix typos in documentation 2023-05-22 23:25:16 -07:00
UsingLibcxx.rst [libc++][doc] Updates the release notes. 2023-07-17 18:41:10 +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.