maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity
llvm-project/libcxx/docs
History
Eric Fiselier 649dcec527 Update year to 2017 
llvm-svn: 290876
 		2017-01-03 11:20:43 +00:00
..
DesignDocs Implement a throwing version of _LIBCPP_ASSERT. 2016-12-28 04:58:52 +00:00
BuildingLibcxx.rst Add start of filesystem benchmarks 2016-10-30 22:53:00 +00:00
CMakeLists.txt
…
Makefile.sphinx Attempt to fix Sphinx build 2016-09-16 03:47:53 +00:00
README.txt Remove test commit. 2015-09-05 05:38:50 +00:00
TestingLibcxx.rst Update TestingLibcxx doc to reflect the use_system_cxx_lib flag. Patch from Michael Park 2016-12-23 19:09:14 +00:00
UsingLibcxx.rst Implement a throwing version of _LIBCPP_ASSERT. 2016-12-28 04:58:52 +00:00
conf.py Update year to 2017 2017-01-03 11:20:43 +00:00
index.rst Remove dead debug_mode doc link 2016-12-28 06:21:09 +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.