darling-libcxx/docs
Eric Fiselier 6e5b234c63 Test commit for sphinx docs try2
git-svn-id: https://llvm.org/svn/llvm-project/libcxx/trunk@246895 91177308-0d34-0410-b5e6-96231b3b80d8
2015-09-04 23:19:11 +00:00
..
BuildingLibcxx.rst [libcxx] Add new Sphinx documentation 2015-08-22 19:40:49 +00:00
CMakeLists.txt [libcxx] Add new Sphinx documentation 2015-08-22 19:40:49 +00:00
conf.py [libcxx] Add new Sphinx documentation 2015-08-22 19:40:49 +00:00
index.rst Test commit for sphinx docs try2 2015-09-04 23:19:11 +00:00
README.txt [libcxx] Add new Sphinx documentation 2015-08-22 19:40:49 +00:00
TestingLibcxx.rst [libcxx] Add new Sphinx documentation 2015-08-22 19:40:49 +00:00
UsingLibcxx.rst [libcxx] Add new Sphinx documentation 2015-08-22 19:40:49 +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.