Sphinx api docs build (#467)

NVIDIA · Feb 19, 2025 · fac912d · fac912d
1 parent cbe293d
commit fac912d
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 16 deletions.
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
@@ -2,25 +2,29 @@ name: Build NV-Ingest Documentation
 
 # Trigger for pull requests and pushing to main
 on:
-  pull_request:
-    types:
-      - opened
-      - synchronize
-      - reopened
+  # Runs on pushes targeting the default branch
   push:
-    branches:
-      - main
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
 
 permissions:
   contents: read
   pages: write
   id-token: write
 
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
 jobs:
   build:
     runs-on: linux-large-disk
     container:
-      image: python:3.11-slim
+      image: ubuntu:latest
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -30,19 +34,25 @@ jobs:
 
       - name: Install system deps
         run: |
-          apt-get update && apt-get install -y make git
+          apt-get update && apt-get install -y make git python3-full
 
       # Install dependencies from docs/requirements.txt
       - name: Install mkdocs dependencies
         run: |
+          python3 -m venv venv
+          source venv/bin/activate
           pip install -r docs/requirements.txt
 
-      # - name: Build Sphinx API Docs
-      #   run: |
-      #     cd docs/sphinx_docs
-      #     make html
-      #     cd ../../
-      #     mv docs/sphinx_docs/build/html docs/docs/user-guide/api_docs
+      - name: Build Sphinx API Docs
+        run: |
+          source venv/bin/activate
+          cd api
+          pip install -e .
+          cd ../
+          cd docs/sphinx_docs
+          make html
+          cd ../../
+          mv docs/sphinx_docs/build/html docs/docs/user-guide/api_docs
 
       - name: Build MkDocs Site
         run: mkdocs build --config-file docs/mkdocs.yml

diff --git a/docs/sphinx_docs/source/conf.py b/docs/sphinx_docs/source/conf.py
@@ -6,7 +6,6 @@
 import sys
 
 sys.path.insert(0, os.path.abspath("../../../api/src"))  # nv-ingest-api src
-print(f"!!!!!sys.path: {sys.path}")
 
 project = "nv-ingest"
 copyright = "2025, Nvidia"