llvm-capstone/libcxx/docs
Louis Dionne 8803112bee [libc++][NFC] Add deprecated mention for _LIBCPP_ENABLE_CXX20_REMOVED_ALLOCATOR_MEMBERS in the docs
This was missed in the patch where I marked the macro as deprecated.
2024-01-16 13:16:15 -05:00
..
DesignDocs [libc++] Rename _LIBCPP_INLINE_VISIBILITY to _LIBCPP_HIDE_FROM_ABI (#74095) 2023-12-04 10:25:14 -05:00
Helpers [libc++] Update status after the Kona meeting. (#72421) 2023-11-16 10:17:19 +01:00
ReleaseNotes [libc++] Deprecate removed features macros. (#77879) 2024-01-16 19:12:59 +01:00
Status [libc++] Implements P2517R1. (#77239) 2024-01-09 19:11:40 +01:00
AddingNewCIJobs.rst [libc++][NFC] Fix typo in documentation 2023-03-02 12:42:15 -05:00
BuildingLibcxx.rst [runtimes] Use LLVM libunwind from libc++abi by default (#77687) 2024-01-11 10:13:21 -05: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++] Replace uses of _VSTD:: by std:: (#74331) 2023-12-05 11:19:15 -05:00
FeatureTestMacroTable.rst Reapply "[libc++][streams] P1759R6: Native handles and file streams" (#77190) 2024-01-07 18:01:03 +02:00
Hardening.rst [libcxx] reorganises the hardening documentation (#73159) 2023-12-06 14:23:35 -08:00
ImplementationDefinedBehavior.rst [libc++][print] Adds ostream overloads. (#73262) 2023-12-19 19:32:17 +01:00
index.rst [libc++][doc] Removes LLVM-17 release notes. (#78062) 2024-01-16 17:26:08 +01:00
Modules.rst [libc++][doc] Updates module information. (#75003) 2023-12-12 19:12:29 +01:00
README.txt
ReleaseProcedure.rst [libc++] Encode the version in the ReleaseNotes file 2023-07-18 14:06:21 -04:00
TestingLibcxx.rst [libc++][docs] Document the libc++ Lit testing format naming scheme (#73136) 2024-01-10 10:51:06 -05:00
UsingLibcxx.rst [libc++][NFC] Add deprecated mention for _LIBCPP_ENABLE_CXX20_REMOVED_ALLOCATOR_MEMBERS in the docs 2024-01-16 13:16:15 -05: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.