llvm-project

History

Louis Dionne 952387251e [libc++] Re-document how to use <filesystem> with various versions of libc++ This documentation was removed when we added <filesystem> to the dylib in r356518, but it really should have been updated to reflect the new state of things. Keeping documentation around doesn't hurt and users will have an easier time migrating. llvm-svn: 356681		2019-03-21 16:21:09 +00:00
..
DesignDocs	[libcxx] Start defining lit features for tests depending on availability	2019-02-05 19:22:38 +00:00
BuildingLibcxx.rst	Allow disabling of filesystem library.	2019-03-21 00:04:31 +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	…
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	[libc++] Re-document how to use <filesystem> with various versions of libc++	2019-03-21 16:21:09 +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.