llvm-project

History

Louis Dionne 91c0a462d8 [libcxx] Mention restriction on inline namespaces in LIBCXX_ABI_NAMESPACE docs I also kept the original "vague" documentation that saying that users are responsible for not breaking us. This doesn't mean anything because there's no way they can actually enforce that unless we restrict ourselves to a specific naming scheme, but I left the documentation because it acts as a good warning and gives us more leeway. llvm-svn: 347052		2018-11-16 14:57:47 +00:00
..
DesignDocs	[libc++] Make sure we can build libc++ with -fvisibility=hidden	2018-10-25 12:13:43 +00:00
BuildingLibcxx.rst	[libcxx] Mention restriction on inline namespaces in LIBCXX_ABI_NAMESPACE docs	2018-11-16 14:57:47 +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	[libc++] Use exclude_from_explicit_instantiation instead of always_inline	2018-10-29 17:30:04 +00:00
TestingLibcxx.rst	Teach test suite about C++2a dialect flag.	2017-11-07 20:26:23 +00:00
UsingLibcxx.rst	[libc++] Add deprecated attributes to many deprecated components	2018-09-23 18:35:00 +00:00
conf.py	fix some typos in the doc	2018-09-20 08:05:01 +00:00
index.rst	Correct docs to reference the new libc++ lists.	2018-09-22 19:49:29 +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.