llvm-capstone/libcxx/docs
2017-05-04 07:40:23 +00:00
..
DesignDocs
BuildingLibcxx.rst
CMakeLists.txt
conf.py
index.rst Update Appveyor bot link to point to new llvm-mirror Appveyor account 2017-05-04 07:40:23 +00:00
Makefile.sphinx
README.txt
TestingLibcxx.rst
UsingLibcxx.rst [libc++] Add _LIBCPP_DISABLE_EXTERN_TEMPLATE config option 2017-04-13 20:13:32 +00:00

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.