Skip to content

Commit c4a9ae3

Browse files
authored
docs: add Reactant.Ops docs to the website (EnzymeAD#362)
1 parent 814e9c0 commit c4a9ae3

File tree

3 files changed

+17
-0
lines changed

3 files changed

+17
-0
lines changed

docs/make.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ pages = [
3030
"Tutorials" => ["Overview" => "tutorials/index.md"],
3131
"API Reference" => [
3232
"Reactant API" => "api/api.md",
33+
"Ops" => "api/ops.md",
3334
"Dialects" => [
3435
"ArithOps" => "api/arith.md",
3536
"Affine" => "api/affine.md",

docs/src/.vitepress/config.mts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ export default defineConfig({
5858
text: "API",
5959
items: [
6060
{ text: "Core Reactant API", link: "/api/api" },
61+
{ text: "Ops", link: "/api/ops" },
6162
{
6263
text: "MLIR Dialects",
6364
items: [
@@ -108,6 +109,7 @@ export default defineConfig({
108109
text: "Reactant API",
109110
link: "/api/api",
110111
},
112+
{ text: "Ops", link: "/api/ops" },
111113
{
112114
text: "MLIR Dialects",
113115
collapsed: false,

docs/src/api/ops.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
```@meta
2+
CollapsedDocStrings = true
3+
```
4+
5+
# `Reactant.Ops` API
6+
7+
`Reactant.Ops` module provides a high-level API to construct MLIR operations without having
8+
to directly interact with the different dialects.
9+
10+
Currently we haven't documented all the functions in `Reactant.Ops`.
11+
12+
```@autodocs
13+
Modules = [Reactant.Ops]
14+
```

0 commit comments

Comments
 (0)