ci: add job for deploying api docs on github pages

Author: mg-twentyone

.github/workflows/python-api-docs.yaml

@@ -1,9 +1,12 @@
-name: Build Python API Docs
+name: Build And Publish Python API Docs
 
 on:
   workflow_dispatch:
 
-permissions: {}
+permissions:
+  contents: read
+  pages: write
+  id-token: write
 
 jobs:
   build-api-docs:
@@ -20,7 +23,7 @@ jobs:
       - name: "Configure Git safe directory"
         run: git config --global --add safe.directory /__w/bdk-python/bdk-python
 
-      - name: Set up Python
+      - name: "Set up Python"
         uses: actions/setup-python@v5
         with:
           python-version: "3.12"
@@ -46,4 +49,21 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: artifact-bdkpython-api-docs
-          path: /home/runner/work/bdk-python/bdk-python/docs/_build/html
+          path: docs/_build/html
+
+      - name: "Upload API Docs for GitHub Pages"
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/_build/html
+
+  deploy-api-docs:
+    name: "Deploy bdkpython API docs on GitHub Pages"
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-24.04
+    needs: build-api-docs
+    steps:
+      - name: "Deploy to GitHub Pages"
+        id: deployment
+        uses: actions/deploy-pages@v4