llvm-project/orc-rt/docs/README.txt
Lang Hames ee7a6a45bd
[ORC-RT] Initial check-in for a new, top-level ORC runtime project. (#113499)
Includes CMake files and placeholder header, library, test tool, regression
test and unit test.

The aim for this project is to create a replacement for the existing ORC
Runtime that currently resides in `llvm-project/compiler-rt/lib/orc`. The new
project will provide a superset of the original features, and the old runtime
will be removed once the new runtime is sufficiently developed.

See discussion at
https://discourse.llvm.org/t/rfc-move-orc-executor-support-into-top-level-project/81049
2025-08-19 10:56:18 +10:00

14 lines
405 B
Plaintext

ORC-RT Documentation
====================
The ORC-RT documentation is written using the Sphinx documentation generator. It is
currently tested with Sphinx 5.3.0.
To build the documents into html configure ORC-RT with the following cmake options:
* -DLLVM_ENABLE_SPHINX=ON
* -DORC_RT_INCLUDE_DOCS=ON
After configuring ORC-RT with these options the make rule `docs-orc-rt-html`
should be available.