![]() This design is borrowed from the lldb folks (thank you!) to declutter the page. * The version number at the top is removed. * Links are pushed over to a sidebar * The sidebar has headings There are other minor changes: * The warning about this project not being ready is now an RST "warning" * Links to the Bug Reports and the Source Code are Added * Refer to this project as either "The LLVM C LIbrary" or "The libc" Tested: Built locally Reviewed By: sivachandra Differential Revision: https://reviews.llvm.org/D131242 |
||
---|---|---|
.. | ||
_static | ||
CMakeLists.txt | ||
README.txt | ||
api_test.rst | ||
build_system.rst | ||
clang_tidy_checks.rst | ||
conf.py | ||
entrypoints.rst | ||
fuzzing.rst | ||
ground_truth_specification.rst | ||
header_gen_scheme.svg | ||
header_generation.rst | ||
implementation_standard.rst | ||
index.rst | ||
layering.rst | ||
math.rst | ||
mechanics_of_public_api.rst | ||
redirectors.rst | ||
redirectors_schematic.svg | ||
runtimes_build.rst | ||
source_layout.rst | ||
stdio.rst | ||
strings.rst |
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.