Add API reference

dottxt-ai · Nov 10, 2023 · f97cddb · f97cddb
1 parent 4d53114
commit f97cddb
Show file tree

Hide file tree

Showing 10 changed files with 25 additions and 2 deletions.
diff --git a/docs/api/continuation.md b/docs/api/continuation.md
@@ -0,0 +1 @@
+::: outlines.text.generate.continuation
diff --git a/docs/api/fsm.md b/docs/api/fsm.md
@@ -0,0 +1 @@
+::: outlines.text.fsm
diff --git a/docs/api/index.md b/docs/api/index.md
@@ -0,0 +1 @@
+# API Reference
diff --git a/docs/api/json_schema.md b/docs/api/json_schema.md
@@ -0,0 +1 @@
+::: outlines.text.json_schema
diff --git a/docs/api/models.md b/docs/api/models.md
@@ -0,0 +1 @@
+::: outlines.models.transformers
diff --git a/docs/api/parsing.md b/docs/api/parsing.md
@@ -0,0 +1 @@
+::: outlines.text.parsing
diff --git a/docs/api/prompts.md b/docs/api/prompts.md
@@ -0,0 +1 @@
+::: outlines.text.prompts
diff --git a/docs/api/regex.md b/docs/api/regex.md
@@ -0,0 +1 @@
+::: outlines.text.generate.regex
diff --git a/docs/api/sample.md b/docs/api/sample.md
@@ -0,0 +1 @@
+::: outlines.text.generate.sample
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -72,11 +72,15 @@ extra_css:
   - stylesheets/extra.css
 
 plugins:
-  - mkdocstrings
+  - mkdocstrings:
+      default_handler: python
+      handlers:
+        python:
+          options:
+            show_submodules: true
   - search
   - section-index
   - social:
-      cards_layout: default/invert
       cards_layout_options:
         color: #173a58
 
@@ -98,3 +102,13 @@ nav:
         - reference/types.md
         - reference/regex.md
         - reference/json.md
+  - API:
+      - api/index.md
+      - api/models.md
+      - api/prompts.md
+      - api/json_schema.md
+      - api/fsm.md
+      - api/parsing.md
+      - api/regex.md
+      - api/sample.md
+      - api/continuation.md