llvm-project/libc/docs
Guillaume Chatelet 436c8f4420 [reland][libc] Add bcopy
Differential Revision: https://reviews.llvm.org/D138994
2022-12-01 10:07:04 +00: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][docs] Move links to internal developer guides out of the main side bar. 2022-11-05 00:04:50 -07:00
build_and_test.rst [libc][docs] Add a build and test document. 2022-11-05 01:06:01 -07:00
check.rst [libc][cleanup] Docs clean up 2022-10-15 15:29:48 +00:00
clang_tidy_checks.rst [libc][docs] Move links to internal developer guides out of the main side bar. 2022-11-05 00:04:50 -07:00
cmake_build_rules.rst [libc][docs] Move links to internal developer guides out of the main side bar. 2022-11-05 00:04:50 -07:00
code_style.rst [libc][docs] Move links to internal developer guides out of the main side bar. 2022-11-05 00:04:50 -07:00
conf.py [libc] Update look and feel of libc.llvm.org 2022-08-05 18:18:40 +00:00
contributing.rst [libc][docs] Move links to internal developer guides out of the main side bar. 2022-11-05 00:04:50 -07:00
date_and_time.rst [libc] Implement gettimeofday 2022-11-11 18:02:33 -08:00
developer_guides.rst [libc][docs] Move links to internal developer guides out of the main side bar. 2022-11-05 00:04:50 -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
gpu_mode.rst [libc][docs] Fix code block not being emitted 2022-11-30 09:33:40 -06:00
ground_truth_specification.rst
header_gen_scheme.svg
header_generation.rst
implementation_standard.rst
index.rst [libc][docs] Add documentation for the new GPU mode 2022-11-29 14:51:55 -06: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][docs] Move links to internal developer guides out of the main side bar. 2022-11-05 00:04:50 -07:00
porting.rst [libc] Add a porting guide to the docs. 2022-11-02 07:59:07 -07:00
source_tree_layout.rst [libc][docs] Move links to internal developer guides out of the main side bar. 2022-11-05 00:04:50 -07:00
stdio.rst [libc][cleanup] Docs clean up 2022-10-15 15:29:48 +00:00
strings.rst [reland][libc] Add bcopy 2022-12-01 10:07:04 +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.