#91 - Add PR doc previews (#90)

* Add PR doc previews

* fix

* try changing branch

* fix mapping

* Remove md files

* Update pr logic

* Add flag

* Add another exclude

* build

* Update with concurrency and cancel

* lint

* lint

Author: RyaliNvidia

.github/workflows/docs-deploy.yaml

@@ -93,10 +93,13 @@ jobs:
   deploy:
     needs: build
     runs-on: ubuntu-latest
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
     steps:
       - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v4
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: gh-pages/documentation
+          folder: docs/public
+          clean-exclude: |
+            pr-preview/
+            .nojekyll
+          force: false

.github/workflows/pr-checks.yaml

@@ -19,8 +19,13 @@ name: PR Checks
 on:
   workflow_dispatch:
   pull_request:
+    types: [opened, synchronize, reopened, closed]
     branches: [ main ]
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number }}
+  cancel-in-progress: true
+
 jobs:
   #######################
   #    Path Filters     #
@@ -69,7 +74,8 @@ jobs:
     needs: [check-paths]
     if: |
       (needs.check-paths.outputs.ci == 'true') &&
-      (github.event_name == 'pull_request' && github.event.pull_request.head.repo.fork == true)
+      (github.event_name == 'pull_request' && github.event.pull_request.head.repo.fork == true) &&
+      (github.event.action != 'closed')
     runs-on: ubuntu-latest
     steps:
       - name: Free disk space
@@ -128,7 +134,8 @@ jobs:
       (
         needs.check-paths.outputs.ci == 'true' &&
         github.event_name == 'pull_request' &&
-        github.event.pull_request.head.repo.fork == false
+        github.event.pull_request.head.repo.fork == false &&
+        github.event.action != 'closed'
       )
     runs-on: self-hosted
     environment:
@@ -193,16 +200,29 @@ jobs:
           python-version: '3.10.18'
 
       - name: Install dependencies
+        if: github.event.action != 'closed'
         run: |
           pip install -U -r docs/locked_requirements.txt
 
       - name: Build Sphinx documentation
+        if: github.event.action != 'closed'
         run: |
           make -C docs build ERR_DIR=build_error_logs OUT_DIR=public
+
+      - name: Deploy preview
+        uses: rossjrw/pr-preview-action@v1
+        with:
+          source-dir: ./docs/public/
+          preview-branch: gh-pages/documentation
+
+      - name: Run spelling and linkcheck
+        if: github.event.action != 'closed'
+        run: |
           make -C docs spelling ERR_DIR=spelling_error_logs OUT_DIR=public
           make -C docs linkcheck ERR_DIR=linkcheck_error_logs OUT_DIR=public
 
       - name: Check for build errors
+        if: github.event.action != 'closed'
         run: |
           has_spelling_errors=false
           has_linkcheck_errors=false
@@ -229,7 +249,7 @@ jobs:
           fi
 
       - name: Upload build artifacts
-        if: always()
+        if: always() && github.event.action != 'closed'
         uses: actions/upload-artifact@v4
         with:
           name: documentation-build
@@ -245,7 +265,9 @@ jobs:
   #######################
   ci-docs:
     needs: [check-paths]
-    if: needs.check-paths.outputs.docs == 'true'
+    if: |
+      (needs.check-paths.outputs.docs == 'true' && github.event.action != 'closed') ||
+      github.event_name == 'workflow_dispatch'
     runs-on: ubuntu-latest
     steps:
       - name: Free disk space
@@ -302,7 +324,9 @@ jobs:
   #######################
   ui-build:
     needs: [check-paths]
-    if: needs.check-paths.outputs.ui == 'true' || github.event_name == 'workflow_dispatch'
+    if: |
+      (needs.check-paths.outputs.ui == 'true' && github.event.action != 'closed') ||
+      github.event_name == 'workflow_dispatch'
     runs-on: ubuntu-latest
     steps:
       - name: Checkout

docs/conf.py

@@ -56,7 +56,7 @@
     '_extensions.domain_config',
     '_extensions.html_translator_mixin',
     '_extensions.markdown_translator',
-    
+
     # Theme extension
     '_extensions.nvidia_theme_override',
 ]
@@ -92,6 +92,8 @@
 
 linkcheck_timeout = 150
 
+linkcheck_report_timeouts_as_broken = False
+
 # Copybutton
 copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
 copybutton_prompt_is_regexp = True