llvm-capstone/libc/docs
2022-04-20 15:33:20 +00:00
..
api_test.rst
build_system.rst
clang_tidy_checks.rst
CMakeLists.txt
conf.py
entrypoints.rst
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
implementation_standard.rst
index.rst [libc] Add a doc describing the current status of libc runtimes build. 2022-04-18 06:48:43 +00:00
layering.rst
mechanics_of_public_api.rst
README.txt
redirectors_schematic.svg
redirectors.rst
runtimes_build.rst [libc] Add a doc describing the current status of libc runtimes build. 2022-04-18 06:48:43 +00:00
source_layout.rst [libc][docs] Remove the description of a "www" directory. 2022-04-18 07:16:21 +00:00
strings.rst [libc][docs] Add doc for libc string functions 2022-04-14 13:03:01 -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.