Skip to content

Commit

Permalink
docs: add Reactant.Ops docs to the website (#362)
Browse files Browse the repository at this point in the history
  • Loading branch information
avik-pal authored Dec 11, 2024
1 parent 814e9c0 commit c4a9ae3
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ pages = [
"Tutorials" => ["Overview" => "tutorials/index.md"],
"API Reference" => [
"Reactant API" => "api/api.md",
"Ops" => "api/ops.md",
"Dialects" => [
"ArithOps" => "api/arith.md",
"Affine" => "api/affine.md",
Expand Down
2 changes: 2 additions & 0 deletions docs/src/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ export default defineConfig({
text: "API",
items: [
{ text: "Core Reactant API", link: "/api/api" },
{ text: "Ops", link: "/api/ops" },
{
text: "MLIR Dialects",
items: [
Expand Down Expand Up @@ -108,6 +109,7 @@ export default defineConfig({
text: "Reactant API",
link: "/api/api",
},
{ text: "Ops", link: "/api/ops" },
{
text: "MLIR Dialects",
collapsed: false,
Expand Down
14 changes: 14 additions & 0 deletions docs/src/api/ops.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
```@meta
CollapsedDocStrings = true
```

# `Reactant.Ops` API

`Reactant.Ops` module provides a high-level API to construct MLIR operations without having
to directly interact with the different dialects.

Currently we haven't documented all the functions in `Reactant.Ops`.

```@autodocs
Modules = [Reactant.Ops]
```

0 comments on commit c4a9ae3

Please sign in to comment.