llvm-project/libcxx/docs
Louis Dionne be00e8893f [libc++] Clarify how we pick the typeinfo comparison
This commit makes it clear that the typeinfo comparison implementation
is automatically selected by default, and that the CMake option only
overrides the value. This has been a source of confusion and bugs ever
since we've introduced complexity in that area, so I'm trying to simplify
it while still allowing for some control on the implementation.

Differential Revision: https://reviews.llvm.org/D91574
2020-11-18 16:58:45 -05:00
..
DesignDocs [libc++] Rework the whole availability markup implementation 2020-11-05 12:28:52 -05:00
BuildingLibcxx.rst [libc++] Clarify how we pick the typeinfo comparison 2020-11-18 16:58:45 -05:00
CMakeLists.txt docs: Fix Sphinx detection with out-of-tree builds 2017-05-09 11:18:03 +00:00
FeatureTestMacroTable.rst [libc++] Implement P0919R3: heterogenous lookup for unordered containers 2020-11-11 17:44:42 -05:00
Makefile.sphinx Add design docs for upcoming file_time_type change. 2018-07-25 02:53:53 +00:00
README.txt
ReleaseNotes.rst [libc++] Define new/delete in libc++abi only by default 2020-10-19 11:35:01 -04:00
TestingLibcxx.rst [libc++] Migrate warning flags to the DSL 2020-11-02 12:25:05 -05:00
UsingLibcxx.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
conf.py Bump the trunk major version to 12 2020-07-15 12:05:05 +02:00
index.rst [libc++] Add a CI job to build the documentation 2020-11-05 15:33:09 -05: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.