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
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
date_and_time.rst
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
gpu_mode.rst
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
README.txt
stdio.rst [libc][docs] update list of completed stdio funcs 2023-03-09 10:44:50 -08:00
strings.rst
usage_modes.rst

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.