llvm-project/libcxx/docs
Louis Dionne 7e6221da10 [libc++] Remove unused functions and minor features of the test suite
This commit removes minor features of the test suite that I've never
seen used and that are basically just a maintenance burden:

- color_diagnostics: Diagnostics are colored by default when running
  from a terminal, and not colored otherwise. This is the right behavior.
  Being able to tweak this has minor value, and could be achieved by
  modifying the %{compile_flags} instead if absolutely needed.

- ccache: This can be achieved by using a wrapper for the %{cxx}
  substitution.

- _dump_macros_verbose is just a dead function now.
2020-05-05 09:58:36 -04:00
..
DesignDocs [libc++] Simplify how with_system_cxx_lib and availability features are defined 2020-04-14 08:28:05 -04:00
BuildingLibcxx.rst [libc++] Fix wrong default value for LIBCXX_ENABLE_ASSERTIONS in documentation 2020-03-30 12:44:57 -04:00
CMakeLists.txt docs: Fix Sphinx detection with out-of-tree builds 2017-05-09 11:18:03 +00:00
FeatureTestMacroTable.rst [libc++][P1115][C++20] Improving the Return Value of Erase-Like Algorithms II: Free erase/erase if. 2020-05-02 14:04:50 +02:00
Makefile.sphinx Add design docs for upcoming file_time_type change. 2018-07-25 02:53:53 +00:00
README.txt
ReleaseNotes.rst Bump the trunk major version to 11 2020-01-15 13:38:01 +01:00
TestingLibcxx.rst [libc++] Remove unused functions and minor features of the test suite 2020-05-05 09:58:36 -04:00
UsingLibcxx.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
conf.py Bump the trunk major version to 11 2020-01-15 13:38:01 +01:00
index.rst [libc++] Bump Clang support for Clang 4 2020-03-23 12:17:04 -04: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.