llvm-capstone/libcxx/docs
Nikolas Klauser b6d2460fd4 [libc++] Remove _LIBCPP_DISABLE_NODISCARD_AFTER_CXX17 documentation
We've removed this flag a while ago, so we shouldn't list it anymore.
2023-09-02 07:17:32 -07:00
..
DesignDocs [libc++] Make everything in namespace std have default type visibility and hidden visibility and remove _LIBCPP_ENUM_VIS 2023-08-19 15:16:04 -07:00
Helpers [libc++] Encode the version in the ReleaseNotes file 2023-07-18 14:06:21 -04:00
ReleaseNotes [libc++] Adds string_view constructor overload 2023-08-25 17:56:27 +02:00
Status [libc++] Implement LWG3464(istream::gcount() can overflow) 2023-08-29 20:18:25 +08: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++][doc] Improves contribution page. 2023-08-29 19:05:31 +02:00
FeatureTestMacroTable.rst [libc++] Adds string_view constructor overload 2023-08-25 17:56:27 +02: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++][C++20 modules] Tests no unicode build. 2023-08-22 20:17:37 +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++] Remove _LIBCPP_DISABLE_NODISCARD_AFTER_CXX17 documentation 2023-09-02 07:17:32 -07: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.