Magic-Mirror/llvm-capstone
1
0
Fork 0
mirror of https://github.com/capstone-engine/llvm-capstone.git synced 2025-02-22 03:03:43 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
llvm-capstone/libc/docs
History
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
[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
…
header_gen_scheme.svg
…
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
Rewrite much of the index page for libc
2022-02-16 03:46:20 +00:00
integration_test.rst
[libc] Add documentation for integration tests.
2020-07-06 12:44:32 -07:00
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_schematic.svg
…
redirectors.rst
Move LLVM Proposal to doc directory, create index
2022-01-29 00:29:31 +00:00
source_layout.rst
Move LLVM Proposal to doc directory, create index
2022-01-29 00:29:31 +00: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.