llvm-capstone/libc/docs
Nick Desaulniers c52b467875
Reapply "[libc] build with -Werror (#73966)" (#74506)
This reverts commit 6886a52d6d.

Most of the errors observed in postsubmit have been addressed. We can
fix-forward the remaining ones.

Link: https://lab.llvm.org/buildbot/#/changes/117129
2024-01-08 09:07:35 -08:00
..
_static [libc] Make the sidebar colors have a higher constract in the white background. 2023-01-05 09:43:59 -08:00
dev Reapply "[libc] build with -Werror (#73966)" (#74506) 2024-01-08 09:07:35 -08:00
gpu [libc] Enable remaining string functions on the GPU (#68346) 2023-10-23 13:16:20 -04:00
math [libc][math] Implement nan(f|l) functions (#76690) 2024-01-05 08:23:23 -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 [libc][cleanup] Docs clean up 2022-10-15 15:29:48 +00:00
CMakeLists.txt
compiler_support.rst [libc] Fix typos in documentation 2023-05-06 11:26:32 -07:00
conf.py [NFC][Py Reformat] Reformat python files in the rest of the dirs 2023-05-25 11:17:05 +02:00
configure.rst [libc] Update configure.rst after config.json modification (#71942) 2023-11-10 16:45:36 +01:00
contributing.rst Fix typos in documentation 2023-08-13 23:46:44 -07:00
date_and_time.rst [libc][docs] Update implementation status table for Date and Time Functions. 2023-05-31 15:09:06 -04:00
full_cross_build.rst [libc] Add two more recipes to do a cross build. 2023-04-18 12:40:14 -07: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
header_gen_scheme.svg
index.rst [libc] Generate configure.rst from the JSON config information. (#65791) 2023-09-08 13:11:09 -07:00
overlay_mode.rst [libc] Fix typos in documentation 2023-04-24 23:31:48 -07:00
porting.rst Fx typos in documentation 2023-08-18 23:36:04 -07:00
README.txt
stdio.rst [libc] Add implementation of getchar 2023-04-14 15:40:05 -07:00
strings.rst [libc][docs] Update implementation docs (#73590) 2023-11-28 10:14:12 -08: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.