1
0
mirror of https://git.FreeBSD.org/src.git synced 2024-12-28 11:57:28 +00:00
Mirror of the FreeBSD src repository https://git.FreeBSD.org/src.git .
Go to file
2018-12-08 14:32:10 +00:00
benchmarks Vendor import of libc++ trunk r338150: 2018-07-28 11:07:56 +00:00
cmake Vendor import of libc++ release_70 branch r348686: 2018-12-08 14:32:10 +00:00
docs Vendor import of libc++ release_70 branch r339999: 2018-08-18 08:27:12 +00:00
fuzzing Vendor import of libc++ trunk r338150: 2018-07-28 11:07:56 +00:00
include Vendor import of libc++ release_70 branch r341916: 2018-09-11 10:10:09 +00:00
lib Vendor import of libc++ trunk r338536: 2018-08-02 17:33:33 +00:00
src Vendor import of libc++ release_70 branch r348686: 2018-12-08 14:32:10 +00:00
test Vendor import of libc++ release_70 branch r341916: 2018-09-11 10:10:09 +00:00
utils Vendor import of libc++ release_70 branch r340910: 2018-08-29 17:51:01 +00:00
www Vendor import of libc++ trunk r338536: 2018-08-02 17:33:33 +00:00
.arcconfig Vendor import of libc++ trunk r321017: 2017-12-18 20:12:08 +00:00
.clang-format Vendor import of libc++ trunk r300422: 2017-04-16 16:03:23 +00:00
.gitignore Vendor import of libc++ trunk r290819: 2017-01-02 19:18:58 +00:00
appveyor-reqs-install.cmd Vendor import of libc++ trunk r338150: 2018-07-28 11:07:56 +00:00
appveyor.yml Vendor import of libc++ trunk r303197: 2017-05-16 19:47:31 +00:00
CMakeLists.txt Vendor import of libc++ release_70 branch r339999: 2018-08-18 08:27:12 +00:00
CREDITS.TXT Vendor import of libc++ trunk r338150: 2018-07-28 11:07:56 +00:00
LICENSE.TXT Vendor import of libc++ trunk r291012: 2017-01-04 22:11:41 +00:00
NOTES.TXT Vendor import of libc++ trunk r338150: 2018-07-28 11:07:56 +00:00
TODO.TXT Vendor import of libc++ trunk r300422: 2017-04-16 16:03:23 +00:00

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.