llvm-project/libcxx/docs
Marek Kurdej 1c656e9b64 [libc++] [docs] Update and move NOTES.txt to docs/Contributing.rst.
Also, add notes about exporting ABI symbols.
Later, we can add notes about using git-clang-format before sending a patch for review.

Reviewed By: ldionne, #libc

Differential Revision: https://reviews.llvm.org/D92300
2020-12-02 08:54:11 +01:00
..
DesignDocs [libc++] Rework the whole availability markup implementation 2020-11-05 12:28:52 -05: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 [libc++] Clarify how we pick the typeinfo comparison 2020-11-18 16:58:45 -05:00
CMakeLists.txt
Contributing.rst [libc++] [docs] Update and move NOTES.txt to docs/Contributing.rst. 2020-12-02 08:54:11 +01:00
Cxx1yStatus.rst [libc++] [docs] Exclude helper files from Sphinx configuration to avoid generating empty pages. 2020-11-27 13:47:20 +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] Exclude helper files from Sphinx configuration to avoid generating empty pages. 2020-11-27 13:47:20 +01:00
Cxx1zStatusIssuesStatus.csv [libc++] [docs] Migrate C++ status pages to RestructuredText (RST). 2020-11-26 10:01:09 +01:00
Cxx1zStatusPaperStatus.csv [libc++] [docs] Migrate C++ status pages to RestructuredText (RST). 2020-11-26 10:01:09 +01:00
Cxx2aStatus.rst [libc++] [docs] Exclude helper files from Sphinx configuration to avoid generating empty pages. 2020-11-27 13:47:20 +01:00
Cxx2aStatusIssuesStatus.csv [NFC][libc++] Mark LWG3296 as complete. 2020-11-26 10:39:44 +01:00
Cxx2aStatusPaperStatus.csv [libc++] P1645 constexpr for <numeric> 2020-11-28 17:02:54 +01:00
FeatureTestMacroTable.rst [libc++] P1645 constexpr for <numeric> 2020-11-28 17:02:54 +01:00
Makefile.sphinx Add design docs for upcoming file_time_type change. 2018-07-25 02:53:53 +00:00
README.txt
ReleaseNotes.rst [libcxx] Implement P1956 rename low-level bit functions 2020-11-24 17:37:06 +01:00
TestingLibcxx.rst [libc++] Migrate warning flags to the DSL 2020-11-02 12:25:05 -05:00
UsingLibcxx.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
conf.py [libc++] [docs] Exclude helper files from Sphinx configuration to avoid generating empty pages. 2020-11-27 13:47:20 +01:00
index.rst [libc++] [docs] Update and move NOTES.txt to docs/Contributing.rst. 2020-12-02 08:54:11 +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.