feat: add documentation

.github/workflows/docs.yaml

@@ -0,0 +1,68 @@
+---
+name: API docs
+
+on: # yamllint disable-line rule:truthy
+  release:
+    types:
+      - published
+  workflow_dispatch: {}
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: Build API docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: actions/checkout
+        uses: indykite/.github/.github/actions/git-checkout@master # actions/checkout with dynamic fetch-depth resolution
+
+      - name: setup/python3
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0 - https://github.com/actions/setup-python/releases
+        with:
+          python-version: "3.14"
+          cache: "pipenv"
+
+      - name: setup/pipenv
+        run: |
+          pipx install pipenv
+          pipenv sync --dev
+
+      - name: Build docs with pdoc
+        run: >-
+          pipenv run pdoc
+          indykite_sdk
+          indykite_sdk.errors
+          indykite_sdk.capture
+          indykite_sdk.authzen
+          indykite_sdk.ciq
+          indykite_sdk.config
+          indykite_sdk.config.models
+          indykite_sdk.data_schema
+          indykite_sdk.entity_matching
+          --docformat google
+          -o site
+
+      - name: pages/upload-artifact
+        uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0 - https://github.com/actions/upload-pages-artifact/releases
+        with:
+          path: site
+
+  deploy:
+    name: Deploy to GitHub Pages
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: pages/deploy
+        id: deployment
+        uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0 - https://github.com/actions/deploy-pages/releases

.github/workflows/tests.yaml

@@ -45,7 +45,7 @@ jobs:
       - name: setup/pipenv
         run: |
           pipx install pipenv
-          pipenv install --dev
+          pipenv sync --dev
 
       - name: Run unit tests
         run: pipenv run pytest --cov . --cov-report xml
@@ -83,7 +83,7 @@ jobs:
       - name: setup/pipenv
         run: |
           pipx install pipenv
-          pipenv install --dev
+          pipenv sync --dev
 
       - name: Run integration tests
         # The integration suite skips itself when credentials are not configured.

Pipfile

@@ -13,6 +13,7 @@ pytest-asyncio = "*"
 respx = "*"
 ruff = "*"
 pylint = "*"
+pdoc = "*"
 
 [requires]
 python_version = "3.14"

README.md

@@ -9,6 +9,7 @@ Python clients for the [IndyKite](https://www.indykite.com) platform REST APIs:
 the Identity Knowledge Graph (IKG), KBAC authorization (AuthZEN), ContX IQ
 knowledge queries, data capture, entity matching, and platform configuration.
 
+- SDK API reference: <https://indykite.github.io/indykite-sdk-python/>
 - OpenAPI reference: <https://openapi.indykite.com>
 - Developer guides: <https://developer.indykite.com>