llvm-capstone/libcxx/docs
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
BuildingLibcxx.rst Update the docs for building libc++. 2019-11-18 12:14:13 -08:00
CMakeLists.txt
conf.py
FeatureTestMacroTable.rst [libc++] [P1612] Add missing feature-test macro __cpp_lib_endian. 2019-11-14 08:55:19 -05:00
index.rst
Makefile.sphinx
README.txt
ReleaseNotes.rst
TestingLibcxx.rst
UsingLibcxx.rst

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.