maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity
llvm-project/libcxx/docs
History
Louis Dionne f7e4f041d6 [libc++] Add a CI job to build the documentation 
At the same time, fix an issue that broke the documentation since 2eadbc8614.
 		2020-11-05 15:33:09 -05:00
..
DesignDocs [libc++] Rework the whole availability markup implementation 2020-11-05 12:28:52 -05:00
BuildingLibcxx.rst [libc++] Provide a default LLVM_PATH when building standalone 2020-06-29 12:40:07 -04:00
CMakeLists.txt
…
FeatureTestMacroTable.rst [libc++] Implement C++20's P0784 (More constexpr containers) 2020-09-22 11:20:33 -04:00
Makefile.sphinx Add design docs for upcoming file_time_type change. 2018-07-25 02:53:53 +00:00
README.txt
…
ReleaseNotes.rst [libc++] Define new/delete in libc++abi only by default 2020-10-19 11:35:01 -04: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 Bump the trunk major version to 12 2020-07-15 12:05:05 +02:00
index.rst [libc++] Add a CI job to build the documentation 2020-11-05 15:33:09 -05: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.