From f97cddb962fd6cedbb79722f9b3ad39b99eaa76e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Louf?= Date: Fri, 10 Nov 2023 16:38:45 +0100 Subject: [PATCH] Add API reference --- docs/api/continuation.md | 1 + docs/api/fsm.md | 1 + docs/api/index.md | 1 + docs/api/json_schema.md | 1 + docs/api/models.md | 1 + docs/api/parsing.md | 1 + docs/api/prompts.md | 1 + docs/api/regex.md | 1 + docs/api/sample.md | 1 + mkdocs.yml | 18 ++++++++++++++++-- 10 files changed, 25 insertions(+), 2 deletions(-) create mode 100644 docs/api/continuation.md create mode 100644 docs/api/fsm.md create mode 100644 docs/api/index.md create mode 100644 docs/api/json_schema.md create mode 100644 docs/api/models.md create mode 100644 docs/api/parsing.md create mode 100644 docs/api/prompts.md create mode 100644 docs/api/regex.md create mode 100644 docs/api/sample.md diff --git a/docs/api/continuation.md b/docs/api/continuation.md new file mode 100644 index 000000000..e8790a2aa --- /dev/null +++ b/docs/api/continuation.md @@ -0,0 +1 @@ +::: outlines.text.generate.continuation diff --git a/docs/api/fsm.md b/docs/api/fsm.md new file mode 100644 index 000000000..7c8f543a9 --- /dev/null +++ b/docs/api/fsm.md @@ -0,0 +1 @@ +::: outlines.text.fsm diff --git a/docs/api/index.md b/docs/api/index.md new file mode 100644 index 000000000..b0d5c88fc --- /dev/null +++ b/docs/api/index.md @@ -0,0 +1 @@ +# API Reference diff --git a/docs/api/json_schema.md b/docs/api/json_schema.md new file mode 100644 index 000000000..78272c9af --- /dev/null +++ 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 new file mode 100644 index 000000000..124e27fee --- /dev/null +++ b/docs/api/models.md @@ -0,0 +1 @@ +::: outlines.models.transformers diff --git a/docs/api/parsing.md b/docs/api/parsing.md new file mode 100644 index 000000000..75efa8467 --- /dev/null +++ b/docs/api/parsing.md @@ -0,0 +1 @@ +::: outlines.text.parsing diff --git a/docs/api/prompts.md b/docs/api/prompts.md new file mode 100644 index 000000000..f9899400e --- /dev/null +++ b/docs/api/prompts.md @@ -0,0 +1 @@ +::: outlines.text.prompts diff --git a/docs/api/regex.md b/docs/api/regex.md new file mode 100644 index 000000000..cdfb9abd7 --- /dev/null +++ b/docs/api/regex.md @@ -0,0 +1 @@ +::: outlines.text.generate.regex diff --git a/docs/api/sample.md b/docs/api/sample.md new file mode 100644 index 000000000..1f962ea16 --- /dev/null +++ b/docs/api/sample.md @@ -0,0 +1 @@ +::: outlines.text.generate.sample diff --git a/mkdocs.yml b/mkdocs.yml index ed7dca575..37fa7ec32 100644 --- 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