llvm-project

History

Jonathan Metzman ff79ee144c Remove repeated words from BuildingLibcxx.rst Summary: Remove repeated words from docs. Reviewers: phosek Reviewed By: phosek Subscribers: christof Differential Revision: https://reviews.llvm.org/D60530 llvm-svn: 358147		2019-04-10 23:44:27 +00:00
..
DesignDocs	[libcxx] Start defining lit features for tests depending on availability	2019-02-05 19:22:38 +00:00
BuildingLibcxx.rst	Remove repeated words from BuildingLibcxx.rst	2019-04-10 23:44:27 +00:00
CMakeLists.txt	docs: Fix Sphinx detection with out-of-tree builds	2017-05-09 11:18:03 +00:00
FeatureTestMacroTable.rst	Implement feature test macros using a script.	2019-01-16 01:37:43 +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	Bump the trunk version to 9.0.0svn	2019-01-16 10:57:02 +00:00
TestingLibcxx.rst	[CMake] Support compiler-rt builtins library in tests	2019-02-05 19:50:47 +00:00
UsingLibcxx.rst	libcxx: Add _LIBCPP_NODISCARD_EXT to 38 more functions	2019-04-03 18:13:08 +00:00
conf.py	Bump the trunk version to 9.0.0svn	2019-01-16 10:57:02 +00:00
index.rst	[libc++][CMake] Clean up some of the libc++ re-exporting logic	2019-03-20 18:16:24 +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.