b9f425a434
Summary: This patch adds Sphinx based documentation to libc++. The goal is to make it easier to write documentation for libc++ since writing new documentation in HTML is cumbersome. This patch rewrites the main page for libc++ along with the instructions for using, building and testing libc++. The built documentation can be found and reviewed here: http://efcs.ca/libcxx-docs In order to build the sphinx documentation you need to specify the cmake options `-DLLVM_ENABLE_SPHINX=ON -DLIBCXX_INCLUDE_DOCS=ON`. This will add the makefile rule `docs-libcxx-html`. Reviewers: chandlerc, mclow.lists, danalbert, jroelofs Subscribers: silvas, cfe-commits Differential Revision: http://reviews.llvm.org/D12129 git-svn-id: https://llvm.org/svn/llvm-project/libcxx/trunk@245788 91177308-0d34-0410-b5e6-96231b3b80d8
14 lines
405 B
Plaintext
14 lines
405 B
Plaintext
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.
|