Add api documents

pasqal-io · Nov 26, 2024 · fd6df11 · fd6df11
1 parent f4774ea
commit fd6df11
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 2 deletions.
diff --git a/docs/api/factory.md b/docs/api/factory.md
@@ -0,0 +1,4 @@
+!!! warning
+	This page is under construction.
+
+::: qadence2_ir.factory
diff --git a/docs/api/factory_tools.md b/docs/api/factory_tools.md
@@ -0,0 +1,5 @@
+!!! warning
+	This page is under construction.
+
+
+::: qadence2_ir.factory_tools
diff --git a/docs/api/irast.md b/docs/api/irast.md
@@ -0,0 +1,4 @@
+!!! warning
+	This page is under construction.
+
+::: qadence2_ir.irast
diff --git a/docs/api/irbuilder.md b/docs/api/irbuilder.md
@@ -0,0 +1,4 @@
+!!! warning
+	This page is under construction.
+
+::: qadence2_ir.irbuilder
diff --git a/docs/api/types.md b/docs/api/types.md
@@ -0,0 +1,4 @@
+!!! warning
+	This page is under construction.
+
+::: qadence2_ir.types
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -15,9 +15,15 @@ nav:
   - Contents:
     - TBD: contents/tbd.md
 
-  - Tutorials:
-    - tutorials/index.md
+  # - Tutorials:
+  #   - tutorials/index.md
 
+  - API:
+    - api/factory.md
+    - api/types.md
+    - api/irast.md
+    - api/irbuilder.md
+    - api/factory_tools.md
 
 theme:
   name: material