autodoc API reference

docs/llm_connect-reference.md

@@ -0,0 +1,5 @@
+# LLM connect module
+
+Here we handle connections to various LLM services, proprietary and open source.
+
+::: biochatter.llm_connect

docs/podcast-reference.md

@@ -0,0 +1,5 @@
+# Podcast module
+
+Here we handle generation of podcasts from texts.
+
+::: biochatter.podcast

docs/prompts-reference.md

@@ -0,0 +1,5 @@
+# Prompts module
+
+Here we handle generation of use case-specific prompts.
+
+::: biochatter.prompts

docs/vectorstore-reference.md

@@ -0,0 +1,6 @@
+# Vectorstore module
+
+Here we handle the application of vectorstore services to retrieval augmented
+generation tasks.
+
+::: biochatter.vectorstore

docs/vectorstore_host-reference.md

@@ -0,0 +1,5 @@
+# Vectorstore host module
+
+Here we handle connections and management of various vectorstore services.
+
+::: biochatter.vectorstore_host

mkdocs.yml

@@ -33,6 +33,10 @@ theme:
   icon:
     repo: fontawesome/brands/github
 
+plugins:
+  - mkdocstrings:
+      default_handler: python
+
 nav:
   - Home: index.md
   - Basic Usage - Chat: chat.md
@@ -41,6 +45,12 @@ nav:
   - Open-source and Local LLMs: open-llm.md
   - Benchmarking: benchmark.md
   - Podcast my Paper: podcast.md
+  - API Reference:
+      - LLM connect: llm_connect-reference.md
+      - Vectorstore: vectorstore-reference.md
+      - Vectorstore Host: vectorstore_host-reference.md
+      - Prompt Engine: prompts-reference.md
+      - Podcast: podcast-reference.md
 
 repo_url: https://github.com/biocypher/biochatter
 repo_name: biocypher/biochatter

pyproject.toml

@@ -37,6 +37,7 @@ xinference = ["botocore", "xinference"]
 pytest = "^7.4.0"
 bump2version = "^1.0.1"
 mkdocs-material = "^9.4.14"
+mkdocstrings = {extras = ["python"], version = "^0.24.0"}
 
 [build-system]
 requires = ["poetry-core"]