darling-libcxx

mirror of https://github.com/darlinghq/darling-libcxx.git synced 2024-11-23 11:59:52 +00:00

History

Eric Fiselier 3cea452823 Correct docs to reference the new libc++ lists. We recently added libcxx-dev and libcxx-commits mailing lists. This patch updates the libc++ documentation to correctly reference the libc++ lists instead of the old Clang ones. git-svn-id: https://llvm.org/svn/llvm-project/libcxx/trunk@342816 91177308-0d34-0410-b5e6-96231b3b80d8		2018-09-22 19:49:29 +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
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
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	[libc++] Add _LIBCPP_ENABLE_NODISCARD and _LIBCPP_NODISCARD_EXT to allow pre-C++2a [[nodiscard]]	2018-09-22 17:54:48 +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.