shylie/llvm-project
1
0
Fork 0
Code Issues Pull Requests Actions 6 Packages Projects Releases Wiki Activity
llvm-project/libcxx/docs
History
Martin Storsjö 6718ce4037 [libcxx] [docs] Fix formatting of inline verbatim snippets in the Windows section 
Use double backticks instead of single, as single backticks produces
italic formatting.
2021-03-17 11:41:45 +02:00
..
DesignDocs
[lic++][docs] Explain noexcept policy for narrow contracts.
2021-02-05 11:27:19 -08:00
Helpers
[libc++] [docs] Exclude helper files from Sphinx configuration to avoid generating empty pages.
2020-11-27 13:47:20 +01:00
AddingNewCIJobs.rst
[libc++] Add documentation for setting up new CI jobs
2020-11-19 14:42:02 -05:00
BuildingLibcxx.rst
[libcxx] [docs] Fix formatting of inline verbatim snippets in the Windows section
2021-03-17 11:41:45 +02:00
CMakeLists.txt
docs: Fix Sphinx detection with out-of-tree builds
2017-05-09 11:18:03 +00:00
conf.py
Bump the trunk major version to 13
2021-01-26 19:37:55 -08:00
Contributing.rst
[libc++] NFC: Document the Differential queries to avoid duplicating work
2021-01-08 17:47:39 -05:00
Cxx1yStatus.rst
[libc++] [docs] Add C++2b (to be C++23) status page.
2020-12-03 09:22:06 +01:00
Cxx1yStatusIssuesStatus.csv
[libc++] [docs] Migrate C++ status pages to RestructuredText (RST).
2020-11-26 10:01:09 +01:00
Cxx1yStatusPaperStatus.csv
[libc++] [docs] Migrate C++ status pages to RestructuredText (RST).
2020-11-26 10:01:09 +01:00
Cxx1zStatus.rst
[libc++] [docs] Add C++2b (to be C++23) status page.
2020-12-03 09:22:06 +01:00
Cxx1zStatusIssuesStatus.csv
[libc++][nfc] SFINAE on pair/tuple assignment operators: LWG 2729.
2021-02-19 13:25:34 -08:00
Cxx1zStatusPaperStatus.csv
[libc++] [docs] Migrate C++ status pages to RestructuredText (RST).
2020-11-26 10:01:09 +01:00
Cxx2aStatus.rst
[libc++] [docs] Add link to clang status page for C++2b and fix anchor for C++20.
2021-03-11 20:49:14 +01:00
Cxx2aStatusIssuesStatus.csv
[libc++] Add bind_front function (P0356R5).
2021-03-02 16:18:06 -08:00
Cxx2aStatusPaperStatus.csv
[libc++] Add bind_front function (P0356R5).
2021-03-02 16:18:06 -08:00
Cxx2bStatus.rst
[libc++] [docs] Add link to clang status page for C++2b and fix anchor for C++20.
2021-03-11 20:49:14 +01:00
Cxx2bStatusIssuesStatus.csv
[libc++] [docs] [C++2b] Update status page with issues (and forgotten papers) adopted in November 2020 and February 2021 virtual meetings.
2021-03-01 11:19:18 +01:00
Cxx2bStatusPaperStatus.csv
[libc++] [C++2b] [P1682] Add to_underlying.
2021-03-05 10:31:21 +01:00
FeatureTestMacroTable.rst
[libc++] [C++2b] [P1682] Add to_underlying.
2021-03-05 10:31:21 +01:00
index.rst
[lic++][docs] Explain noexcept policy for narrow contracts.
2021-02-05 11:27:19 -08: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
Revert "[libc++] Require C++20 to build the benchmarks."
2021-02-09 19:59:34 +01:00
TestingLibcxx.rst
[libc++] Rename check-cxx-deps to cxx-test-depends for consistency
2021-01-18 14:41:53 -05:00
UsingLibcxx.rst
[libc++] Use c++20 instead of c++2a consistently.
2021-01-07 13:11:33 +01: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.