docs: add Reactant.Ops docs to the website (#362)

EnzymeAD · Dec 11, 2024 · c4a9ae3 · c4a9ae3
1 parent 814e9c0
commit c4a9ae3
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -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",

diff --git a/docs/src/.vitepress/config.mts b/docs/src/.vitepress/config.mts
@@ -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: [
@@ -108,6 +109,7 @@ export default defineConfig({
             text: "Reactant API",
             link: "/api/api",
           },
+          { text: "Ops", link: "/api/ops" },
           {
             text: "MLIR Dialects",
             collapsed: false,

diff --git a/docs/src/api/ops.md b/docs/src/api/ops.md
@@ -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]
+```