hanchenye-llvm-project/libcxx/docs
Eric Fiselier e44604aec7 Update libcxx.llvm.org documentation by linking to new docs.
Summary:
Currently much of the libcxx website is duplicated between the old www/ documentation and newer Sphinx docs. This patch changes the main libc++ webpage so that it links to the new documentation where possible. This means removing numerous sections from the landing page.

@mclow.lists What do you think?

Reviewers: mclow.lists

Subscribers: cfe-commits, mclow.lists

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

llvm-svn: 271469
2016-06-02 02:16:28 +00:00
..
DesignDocs Use __config_site when building libc++. Also cleanup ABI versioning doc 2015-10-14 00:22:05 +00:00
BuildingLibcxx.rst Update libcxx.llvm.org documentation by linking to new docs. 2016-06-02 02:16:28 +00:00
CMakeLists.txt
Makefile.sphinx
README.txt
TestingLibcxx.rst Fix sphinx build. This is a temporary solution. 2016-05-05 08:12:25 +00:00
UsingLibcxx.rst Fix errors in documentation 2016-05-06 04:49:30 +00:00
conf.py Update version numbers in docs 2016-05-03 22:50:33 +00:00
index.rst Add links to libc++ code coverage and builders 2015-10-15 03:27:02 +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.