llvm/libc/docs
Jeff Bailey 171cb8f53f Rewrite much of the index page for libc
The prior page was the proposal doc, this one is now
more about what the project intends to do, written in the
present tense.

Reviewed By: sivachandra

Differential Revision: https://reviews.llvm.org/D119379
2022-02-16 03:46:20 +00:00
..
build_system.rst
clang_tidy_checks.rst
CMakeLists.txt Move LLVM Proposal to doc directory, create index 2022-01-29 00:29:31 +00:00
conf.py Move LLVM Proposal to doc directory, create index 2022-01-29 00:29:31 +00:00
entrypoints.rst
fuzzing.rst
ground_truth_specification.rst
header_gen_scheme.svg
header_generation.rst
implementation_standard.rst
index.rst Rewrite much of the index page for libc 2022-02-16 03:46:20 +00:00
integration_test.rst
layering.rst Rewrite much of the index page for libc 2022-02-16 03:46:20 +00:00
mechanics_of_public_api.rst
README.txt Move LLVM Proposal to doc directory, create index 2022-01-29 00:29:31 +00:00
redirectors.rst Move LLVM Proposal to doc directory, create index 2022-01-29 00:29:31 +00:00
redirectors_schematic.svg
source_layout.rst Move LLVM Proposal to doc directory, create index 2022-01-29 00:29:31 +00: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.