darling-libcxx

mirror of https://github.com/darlinghq/darling-libcxx.git synced 2024-11-23 11:59:52 +00:00

History

Saleem Abdulrasool 825410b082 docs: add documentation for `LIBCXX_INCLUDE_TESTS` Add some missing documentation for the `LIBCXX_INCLUDE_TESTS` option. Patch by Jean Heyd Meneide! git-svn-id: https://llvm.org/svn/llvm-project/libcxx/trunk@365154 91177308-0d34-0410-b5e6-96231b3b80d8		2019-07-04 19:08:16 +00:00
..
DesignDocs	Add documentation and tests for Clangs C++11 extensions in C++03.	2019-06-11 22:53:49 +00:00
BuildingLibcxx.rst	docs: add documentation for `LIBCXX_INCLUDE_TESTS`	2019-07-04 19:08:16 +00:00
CMakeLists.txt	docs: Fix Sphinx detection with out-of-tree builds	2017-05-09 11:18:03 +00:00
conf.py	Bump the trunk version to 9.0.0svn	2019-01-16 10:57:02 +00:00
FeatureTestMacroTable.rst	P0722R3: Implement library support for destroying delete	2019-05-23 23:46:44 +00:00
index.rst	Make GCC in C++03 Unsupported	2019-06-13 00:37:25 +00:00
Makefile.sphinx	Add design docs for upcoming file_time_type change.	2018-07-25 02:53:53 +00:00
README.txt	Remove test commit.	2015-09-05 05:38:50 +00:00
ReleaseNotes.rst	Bump the trunk version to 9.0.0svn	2019-01-16 10:57:02 +00:00
TestingLibcxx.rst	[CMake] Support compiler-rt builtins library in tests	2019-02-05 19:50:47 +00:00
UsingLibcxx.rst	[libcxx] Slightly improved policy for handling experimental features	2019-06-11 14:48:40 +00: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.