llvm-project

History

Eric Fiselier 27c1e5c2a9 Cleanup BuildingLibcxx.rst and remove TODO llvm-svn: 246952		2015-09-06 23:31:16 +00:00
..
BuildingLibcxx.rst	Cleanup BuildingLibcxx.rst and remove TODO	2015-09-06 23:31:16 +00:00
CMakeLists.txt	…
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	…
UsingLibcxx.rst	…
conf.py	…
index.rst	Fix another bad link in the new docs	2015-09-06 23:22: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.