feat: add API docs (#181)

Author: mathislucka

.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
     name: Run Tests
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Install uv
         uses: astral-sh/setup-uv@v5

.github/workflows/docker_push.yml

@@ -15,7 +15,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3

.github/workflows/publish_docs.yml

@@ -0,0 +1,30 @@
+name: Deploy Documentation
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+    - uses: actions/checkout@v5
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
+    - run: pip install mkdocs mkdocs-material mkdocstrings[python]
+    - run: mkdocs build
+    - uses: actions/configure-pages@v5
+    - uses: actions/upload-pages-artifact@v3
+      with:
+        path: ./site
+    - id: deployment
+      uses: actions/deploy-pages@v4

.github/workflows/pypi_release.yml

@@ -9,7 +9,7 @@ jobs:
     name: Build distribution
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
       with:
         persist-credentials: false
     - name: Install uv

docs/index.md

@@ -0,0 +1 @@
+# deepset MCP

docs/reference.md

@@ -0,0 +1,3 @@
+# API Reference
+
+::: deepset_mcp.api

mkdocs.yml

@@ -0,0 +1,20 @@
+site_name: deepset MCP Documentation
+theme:
+  name: material
+  features:
+    - navigation.sections
+    - navigation.expand
+    - search.suggest
+
+plugins:
+  - search
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            docstring_style: sphinx  # or numpy/sphinx
+            show_source: false
+
+nav:
+  - Home: index.md
+  - API Reference: reference.md