Implement jobs to build and deploy docs

ROCKY-20651
ansys · Nov 30, 2023 · e872bce · e872bce
1 parent c5e198c
commit e872bce
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 6 deletions.
diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml
@@ -11,6 +11,7 @@ env:
   MAIN_PYTHON_VERSION : '3.10'
   LIBRARY_NAME: 'ansys-rocky-core'
   DOCUMENTATION_CNAME: 'rocky.docs.pyansys.com'
+  DOC_DEPLOYMENT_IMAGE_TAG: v24.1.0
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -47,12 +48,60 @@ jobs:
         run: |
           .venv/Scripts/activate.bat
 
-          python examples/run_examples.py
+          python run_examples.py
 
       - name: Test Report
         uses: dorny/test-reporter@v1
         if: success() || failure()    # run this step even if previous step failed
         with:
           name: Pytest Report
           path: build/pytest.xml    # Path to test results
-          reporter: java-junit
+          reporter: java-junit
+
+  docs_build:
+    name: Build Documentation
+    runs-on: [self-hosted, Windows, pyrocky]
+    env:
+      ANSYSLMD_LICENSE_FILE: 1055@${{ secrets.LICENSE_SERVER }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: "Install"
+        run: |
+          python -m venv .venv
+          .venv/Scripts/activate.bat
+
+          pip install -e .[dev]
+
+      - name: Build Source Documentation
+        run: |
+          .venv/Scripts/activate.bat
+          doc\make.bat html
+
+      - name: Zip HTML Documentation before upload
+        run: |
+          cd doc\_build\html
+          Compress-Archive * ../../../HTML-Documentation-tag-${{ env.DOC_DEPLOYMENT_IMAGE_TAG }}.zip
+
+      - name: Upload HTML Documentation
+        uses: actions/upload-artifact@v3
+        with:
+          name: HTML-Documentation-tag-${{ env.DOC_DEPLOYMENT_IMAGE_TAG }}
+          path: HTML-Documentation-tag-${{ env.DOC_DEPLOYMENT_IMAGE_TAG }}.zip
+          retention-days: 7
+
+
+  doc-deploy-dev:
+    name: "Deploy development documentation"
+    # Deploy development only when merging or pushing to the 'main' branch
+    if: github.event_name == 'push' && !contains(github.ref, 'refs/tags')
+    runs-on: ubuntu-latest
+    needs: docs_build
+    steps:
+      - uses: ansys/actions/doc-deploy-dev@v4
+        with:
+          doc-artifact-name: 'HTML-Documentation-tag-${{ env.DOC_DEPLOYMENT_IMAGE_TAG }}'
+          decompress-artifact: true
+          cname: ${{ env.DOCUMENTATION_CNAME }}
+          token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/pyproject.toml b/pyproject.toml
@@ -24,8 +24,8 @@ dependencies = [
   "numpy >=1.19, <2.0",
   "ansys-sphinx-theme ==0.9.9",
   "numpydoc ==1.5.0",
-  "Sphinx ==6.2.1",
-  "sphinx-copybutton ==0.5.1",
+  "Sphinx ==7.2.6",
+  "sphinx-copybutton ==0.5.2",
   "sphinx-gallery ==0.14.0",
   "matplotlib ==3.8.2", # required by sphinx-gallery
 ]

diff --git a/examples/run_examples.py → run_examples.py b/examples/run_examples.py → run_examples.py
@@ -6,9 +6,8 @@
 
 def run_examples() -> None:
     path = Path(os.path.realpath(__file__))
-    examples_path = path.parent
+    examples_path = path.parent / "examples"
     example_files = list(examples_path.rglob("*.py"))
-    example_files.remove(path)
 
     example_failed = False
     for f in example_files: