llvm-project

History

Dan Albert 626260cfe3 Update the docs for building libc++. Summary: Rewrite the in-tree build to be a clearer tl;dr like we have for the out-of-tree build. Reviewers: EricWF, mclow.lists, ldionne Reviewed By: ldionne Subscribers: dexonsmith, christof, ldionne, enh, libcxx-commits Tags: #libc Differential Revision: https://reviews.llvm.org/D69917		2019-11-18 12:14:13 -08:00
..
DesignDocs	Add documentation and tests for Clangs C++11 extensions in C++03.	2019-06-11 22:53:49 +00:00
BuildingLibcxx.rst	Update the docs for building libc++.	2019-11-18 12:14:13 -08:00
CMakeLists.txt	docs: Fix Sphinx detection with out-of-tree builds	2017-05-09 11:18:03 +00:00
FeatureTestMacroTable.rst	[libc++] [P1612] Add missing feature-test macro __cpp_lib_endian.	2019-11-14 08:55:19 -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	Bump the trunk version to 10.0.0svn	2019-07-18 11:51:05 +00:00
TestingLibcxx.rst	Reformat the beginning of the testing doc to make clear how to run all the tests.	2019-09-05 00:38:36 +00:00
UsingLibcxx.rst	[libc++] Use [[nodiscard]] for lock_guard, as an extension	2019-08-13 11:12:28 +00:00
conf.py	Bump the trunk version to 10.0.0svn	2019-07-18 11:51:05 +00:00
index.rst	Make GCC in C++03 Unsupported	2019-06-13 00:37:25 +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.