generic-library/cxx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
73ffc78616
cxx/docs
History
Eric Fiselier 73ffc78616 [libcxx] Capture configuration information when installing the libc++ headers 
Summary:
Hi all,

This patch is a successor to D11963. However it has changed dramatically and I felt it would be best to start a new review thread.

Please read the design documentation added in this patch for a description of how it works.

Reviewers: mclow.lists, danalbert, jroelofs, EricWF

Subscribers: vkalintiris, rnk, ed, espositofulvio, asl, eugenis, cfe-commits

Differential Revision: http://reviews.llvm.org/D13407

git-svn-id: https://llvm.org/svn/llvm-project/libcxx/trunk@250235 91177308-0d34-0410-b5e6-96231b3b80d8
2015-10-13 22:12:02 +00:00
..
DesignDocs [libcxx] Capture configuration information when installing the libc++ headers 2015-10-13 22:12:02 +00:00
BuildingLibcxx.rst Cleanup BuildingLibcxx.rst and remove TODO 2015-09-06 23:31:16 +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 [libcxx] Capture configuration information when installing the libc++ headers 2015-10-13 22:12:02 +00:00
Makefile.sphinx Test commit for builder 2015-09-05 05:29:23 +00:00
README.txt Remove test commit. 2015-09-05 05:38:50 +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

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.