shylie/llvm-project
1
0
Fork 0
Code Issues Pull Requests Actions 6 Packages Projects Releases Wiki Activity
llvm-project/libc/docs
History
Siva Chandra Reddy f8cdbeb471 [libc][docs] Remove the description of a "www" directory. 
We plan to use the "docs" directory as the home for our "www" pages,
similar to how it is for the libcxx project.
2022-04-18 07:16:21 +00:00
..
api_test.rst
[libc] Rename libc-integration-test to libc-api-test.
2022-03-23 20:25:34 +00:00
build_system.rst
…
clang_tidy_checks.rst
[libc][clang-tidy] fix namespace check for externals
2021-11-30 11:44:24 -08:00
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
[NFC] Trim trailing whitespace in *.rst
2021-11-15 09:17:08 +08:00
ground_truth_specification.rst
[libc] Add a TableGen based header generator.
2019-11-22 13:02:24 -08:00
header_gen_scheme.svg
[libc] Add a TableGen based header generator.
2019-11-22 13:02:24 -08:00
header_generation.rst
[libc] NFC: Fix trivial typo in comments, documents, and messages
2020-04-06 16:19:34 +09:00
implementation_standard.rst
[libc] NFC: Fix trivial typo in comments, documents, and messages
2020-04-06 16:19:34 +09:00
index.rst
[libc] Add a doc describing the current status of libc runtimes build.
2022-04-18 06:48:43 +00:00
layering.rst
Rewrite much of the index page for libc
2022-02-16 03:46:20 +00:00
mechanics_of_public_api.rst
[libc] Add a TableGen based header generator.
2019-11-22 13:02:24 -08:00
README.txt
Move LLVM Proposal to doc directory, create index
2022-01-29 00:29:31 +00:00
redirectors_schematic.svg
…
redirectors.rst
Move LLVM Proposal to doc directory, create index
2022-01-29 00:29:31 +00:00
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

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.