getzep · danielchalef · Oct 13, 2023 · Oct 13, 2023
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
@@ -5,22 +5,37 @@ on:
     branches:
       - main
 
+# Sets the GITHUB_TOKEN permissions to allow deployment to GitHub Pages
 permissions:
-  contents: write
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: 'pages'
+  cancel-in-progress: true
+
 jobs:
   deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
         with:
           python-version: "3.11"
-      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
-      - uses: actions/cache@v3
+      - run: pip install pdoc3
+      - run: pdoc --html --output-dir docs zep_python
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
         with:
-          key: mkdocs-material-${{ env.cache_id }}
-          path: .cache
-          restore-keys: |
-            mkdocs-material-
-      - run: pip install -r docs/requirements.txt
-      - run: mkdocs gh-deploy --force
+          # Upload docs folder as artifact
+          path: './docs'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1
diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-.PHONY: all format lint test tests
+.PHONY: all format lint test test coverage docs
 
 all: help
 
@@ -8,6 +8,9 @@ coverage:
 		--cov-report xml \
 		--cov-report term-missing:skip-covered
 
+docs:
+	poetry run pdoc --html --output-dir docs zep_python
+
 format:
 	poetry run black .
 	poetry run ruff --select I --fix .

diff --git a/docs/documents.md b/docs/documents.md
diff --git a/docs/exceptions.md b/docs/exceptions.md
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/memory.md b/docs/memory.md
diff --git a/docs/models_document.md b/docs/models_document.md
diff --git a/docs/models_memory.md b/docs/models_memory.md
diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/docs/zep_client.md b/docs/zep_client.md
diff --git a/mkdocs.yml b/mkdocs.yml
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -24,12 +24,10 @@ black = "^23.3.0"
 ruff = "^0.0.265"
 mypy = "^1.2.0"
 pre-commit = "^3.3.1"
-mkdocs = "^1.4.3"
-mkdocstrings = {version = "0.21.2", extras = ["python"]}
-mkdocs-material = "^9.1.13"
 pytest-httpx = "^0.22.0"
 faker = "^19.2.0"
 python-dotenv = "^1.0.0"
+pdoc3 = "^0.10.0"
 
 [build-system]
 requires = ["poetry-core"]