ci: fix docs generation flow

Author: mg-twentyone

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

@@ -1,7 +1,9 @@
 name: Build and Upload Python API Docs
 
 on:
-  pull_request:
+  push:
+      branches:
+      - docs/api-docs
   workflow_dispatch:
 
 permissions: {}
@@ -10,13 +12,26 @@ jobs:
   build-docs:
     name: "Build and Upload API Documentation"
     runs-on: ubuntu-24.04
+    container:
+      image: quay.io/pypa/manylinux_2_28_x86_64
+      env:
+        PLAT: manylinux_2_28_x86_64
+        PYBIN: "/opt/python/cp310-cp310/bin"
     steps:
       - name: "Checkout"
         uses: actions/checkout@v4
         with:
           submodules: recursive
           persist-credentials: false
           fetch-depth: 0
+      
+      - name: "Install Rust 1.84.1"
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: 1.84.1
+
+      - name: "Configure Git safe directory"
+        run: git config --global --add safe.directory /__w/bdk-python/bdk-python
 
       - name: "Set up Python"
         uses: actions/setup-python@v4
@@ -25,17 +40,20 @@ jobs:
 
       - name: "Install Sphinx and Theme"
         run: |
-          python3 -m pip install --upgrade pip
-          pip install sphinx sphinx_rtd_theme
+          ${PYBIN}/python -m pip install --upgrade pip
+          ${PYBIN}/pip install sphinx sphinx_rtd_theme
 
-      - name: "Build python API Documentation"
+      - name: "Generate python API Documentation"
         run: |
           bash ./scripts/generate-linux.sh
-          cd ./docs/
-          python3 generate_docs.py
+          ${PYBIN}/python docs/generate_docs.py
+      
+      - name: "Build HTML Documentation"
+        run: |
+          ${PYBIN}/sphinx-build -b  html -W --keep-going  docs/source docs/_build/html
 
       - name: "Upload API Docs"
         uses: actions/upload-artifact@v4
         with:
           name: artifact-python-api-docs
-          path: /home/runner/work/bdk-python/bdk-python/docs/_build/html
+          path: /home/runner/work/bdk-python/bdk-python/docs/_build/html

docs/generate_docs.py

@@ -3,9 +3,9 @@
 import subprocess
 import shutil
 
-# ------------------------
-# Step 1: Generate API RST
-# ------------------------
+# ----------------
+# Generate API RST
+# ----------------
 
 # Define the directory where the Python source files are located
 src_dir = 'src/bdkpython'
@@ -48,27 +48,4 @@
 with open(output_file, 'w') as f:
     f.write(rst_content)
 
-print(f"API documentation has been generated in {output_file}")
-
-# -----------------------
-# Step 2: Build HTML docs
-# -----------------------
-
-BUILD_DIR = 'docs/_build/html'
-SOURCE_DIR = 'docs/source'
-
-# Clean previous HTML build
-if os.path.exists(BUILD_DIR):
-    shutil.rmtree(BUILD_DIR)
-
-# Run Sphinx build
-subprocess.run([
-    "sphinx-build",
-    "-b", "html",
-    "-W",                # treat warnings as errors
-    "--keep-going",      # continue despite warnings
-    SOURCE_DIR,
-    BUILD_DIR
-], check=True)
-
-print(f"HTML documentation has been built in {BUILD_DIR}")
+print(f"API documentation has been generated in {output_file}")

docs/source/conf.py

@@ -5,7 +5,7 @@
 
 import os
 import sys
-sys.path.insert(0, os.path.abspath('../../src/bdkpython'))
+sys.path.insert(0, os.path.abspath('../../src'))
 
 
 # -- Project information -----------------------------------------------------