llvm-capstone/libc/docs/README.txt
Jeff Bailey 4465c29906 Move LLVM Proposal to doc directory, create index
The LLVM Libc project is no longer just a proposal and should have
a webpage tracking the status of the project.  This changes
puts the pieces into the right place so that the webpage can be
created.

Reviewed By: sivachandra

Differential Revision: https://reviews.llvm.org/D117436
2022-01-29 00:29:31 +00:00

14 lines
391 B
Plaintext

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.