llvm-project/libc/docs
Siva Chandra Reddy 136b927c9e [libc] Add a doc about the libc fullbuild mode.
Reviewed By: jeffbailey

Differential Revision: https://reviews.llvm.org/D137061
2022-11-02 08:18:48 -07:00
..
_static [libc] Website fixes (sidebar and mobile) 2022-08-08 18:38:01 +00:00
CMakeLists.txt Move LLVM Proposal to doc directory, create index 2022-01-29 00:29:31 +00:00
README.txt Move LLVM Proposal to doc directory, create index 2022-01-29 00:29:31 +00:00
api_test.rst [libc] Rename libc-integration-test to libc-api-test. 2022-03-23 20:25:34 +00:00
build_system.rst [libc] Cleanup stale documentation. 2022-10-26 22:53:15 -07:00
check.rst [libc][cleanup] Docs clean up 2022-10-15 15:29:48 +00:00
clang_tidy_checks.rst [libc] Add a contributing guide to the docs. 2022-11-02 08:02:11 -07:00
conf.py [libc] Update look and feel of libc.llvm.org 2022-08-05 18:18:40 +00:00
contributing.rst [libc] Add a contributing guide to the docs. 2022-11-02 08:02:11 -07:00
date_and_time.rst [libc] Add implementation of difftime function. 2022-10-24 15:14:26 -07:00
entrypoints.rst [libc] Add a porting guide to the docs. 2022-11-02 07:59:07 -07:00
fullbuild_mode.rst [libc] Add a doc about the libc fullbuild mode. 2022-11-02 08:18:48 -07:00
fuzzing.rst [libc][docs] Update the fuzzing doc to better reflect the current state. 2022-04-20 15:33:20 +00:00
ground_truth_specification.rst
header_gen_scheme.svg
header_generation.rst [libc] NFC: Fix trivial typo in comments, documents, and messages 2020-04-06 16:19:34 +09:00
implementation_standard.rst [libc] NFC: Fix trivial typo in comments, documents, and messages 2020-04-06 16:19:34 +09:00
index.rst [libc] Add links to libc Discourse and to the libc Discord channel. 2022-11-02 08:03:53 -07:00
math.rst [libc] Add a contributing guide to the docs. 2022-11-02 08:02:11 -07:00
mechanics_of_public_api.rst
overlay_mode.rst [libc] Add a doc about the libc overlay mode. 2022-10-26 21:53:29 -07:00
porting.rst [libc] Add a porting guide to the docs. 2022-11-02 07:59:07 -07:00
source_layout.rst [libc][docs] Use same formatting for headers in source_layout 2022-05-23 21:47:22 +00:00
stdio.rst [libc][cleanup] Docs clean up 2022-10-15 15:29:48 +00:00
strings.rst [libc][cleanup] Docs clean up 2022-10-15 15:29:48 +00:00
usage_modes.rst [libc] Add a doc about the libc overlay mode. 2022-10-26 21:53:29 -07: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
  * -DLIBC_INCLUDE_DOCS=ON

After configuring libc with these options the make rule `docs-libc-html`
should be available.