llvm-project

History

Sylvestre Ledru 6616b4c9e9 fix some typos in the doc llvm-svn: 342628		2018-09-20 08:05:01 +00:00
..
DesignDocs	fix some typos in the doc	2018-09-20 08:05:01 +00:00
BuildingLibcxx.rst	[libcxx] By default, do not use internal_linkage to hide symbols from the ABI	2018-08-16 12:44:28 +00:00
CMakeLists.txt	docs: Fix Sphinx detection with out-of-tree builds	2017-05-09 11:18:03 +00:00
Makefile.sphinx	Add design docs for upcoming file_time_type change.	2018-07-25 02:53:53 +00:00
README.txt	Remove test commit.	2015-09-05 05:38:50 +00:00
ReleaseNotes.rst	ReleaseNotes: update links to use https	2018-09-10 08:57:12 +00:00
TestingLibcxx.rst	Teach test suite about C++2a dialect flag.	2017-11-07 20:26:23 +00:00
UsingLibcxx.rst	Implement <filesystem>	2018-07-27 03:07:09 +00:00
conf.py	fix some typos in the doc	2018-09-20 08:05:01 +00:00
index.rst	refresh the libc++ homepage	2018-09-20 07:57:31 +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.