llvm-project/libc/docs
Siva Chandra Reddy 08b9835072 [libc][docs] Add a section about allocations and deallocations to the style doc.
Fixes #59277 - The main part of that bug has already been addressed. This commit
just adds documentation.

Reviewed By: jeffbailey

Differential Revision: https://reviews.llvm.org/D146115
2023-03-15 20:41:51 -07:00
..
_static [libc] Make the sidebar colors have a higher constract in the white background. 2023-01-05 09:43:59 -08:00
dev [libc][docs] Add a section about allocations and deallocations to the style doc. 2023-03-15 20:41:51 -07:00
math [libc][doc] Move docs/math.rst to docs/math/index.rst 2023-02-14 13:41:44 -05:00
build_and_test.rst [libc][bazel] Add bazel targets and unit tests for math functions. 2023-02-03 15:11:20 -05:00
check.rst
CMakeLists.txt
compiler_support.rst [libc][docs] Move the link to "Compiler Support" under "Status". 2023-03-15 20:41:10 -07:00
conf.py
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
full_cross_build.rst [libc] Update cross-compilation instructions 2023-03-14 05:31:20 +00:00
full_host_build.rst [libc] Add instructions for linux headers 2023-03-15 03:02:16 +00:00
fullbuild_mode.rst [libc] Add document for a recipe to do a full standalone cross-build. 2023-01-05 09:37:21 -08:00
gpu_mode.rst [libc] Add support for standalone cross compilation of libc. 2022-12-20 00:33:35 +00:00
header_gen_scheme.svg
index.rst [libc][docs] Move the link to "Compiler Support" under "Status". 2023-03-15 20:41:10 -07:00
overlay_mode.rst [libc][Obvious] Change ninja llvmlibc to ninja libc in the documentations. 2023-02-03 15:16:01 -05:00
porting.rst [libc] Add a porting guide to the docs. 2022-11-02 07:59:07 -07:00
README.txt
stdio.rst [libc][docs] update list of completed stdio funcs 2023-03-09 10:44:50 -08: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

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.