mirror-llvm-project/orc-rt/docs
Lang Hames 5246dffd0e
[orc-rt] Add a coding conventions doc (#208623)
Add docs/CodingConventions.md, recording that ORC-RT follows the LLVM
Coding Standards and describing the C API naming conventions.
2026-07-10 16:33:41 +10:00
..
Building-orc-rt.md
CMakeLists.txt
CodingConventions.md [orc-rt] Add a coding conventions doc (#208623) 2026-07-10 16:33:41 +10:00
conf.py [docs] Create utils/docs (#203962) 2026-06-24 15:12:48 -04:00
Design.md [orc-rt] Update Session shutdown sequence docs / comments. (#190783) 2026-04-07 22:57:16 +10:00
ErrorHandling.md
index.md [orc-rt] Add a coding conventions doc (#208623) 2026-07-10 16:33:41 +10:00
README.txt

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.