WIP

.github/workflows/ci_cd.yml

@@ -19,6 +19,7 @@ env:
   PYAEDT_NON_GRAPHICAL: '1'
   # To keep as it impacts pyaedt behavior
   PYAEDT_DOC_GENERATION: '1'
+  SPHINXBUILD_HTML_AND_PDF_WORKFLOW: '1'
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -41,6 +42,8 @@ jobs:
   doc-build:
     name: Build documentation
     runs-on: [self-hosted, Windows, pyaedt-examples]
+    env:
+      FORCE_COLOR: '1'
     steps:
       - uses: actions/checkout@v4
 
@@ -62,13 +65,11 @@ jobs:
           .venv\Scripts\Activate.ps1
           pip install --no-cache-dir -r requirements/requirements_doc.txt
 
-      # Use environment variable speed up build for PDF pages
       - name: Create HTML documentation
-        env:
-          SPHINXBUILD_HTML_AND_PDF_WORKFLOW: "1"
         run: |
           .venv\Scripts\Activate.ps1
           . .\doc\make.bat html --color
+          . .\doc\make.bat pdf
 
       # NOTE: Ugly HTML checking but redirecting errors with our docs either leads
       # to errors in powershell or workflows getting stuck in Github CICD.
@@ -81,22 +82,19 @@ jobs:
             exit 1            
           }
 
+      - name: Create HTML documentation
+        run: |
+          .venv\Scripts\Activate.ps1
+          . .\doc\make.bat html --color
+          . .\doc\make.bat pdf
+
       - name: Upload HTML documentation artifact
         uses: actions/upload-artifact@v4
         with:
           name: documentation-html
           path: doc/_build/html
           retention-days: 7
 
-      # Use environment variable to remove the doctree after the build of PDF pages
-      # Keeping doctree could cause an issue, see https://github.com/ansys/pyaedt/pull/3844/files
-      - name: Create PDF documentation
-        env:
-          SPHINXBUILD_HTML_AND_PDF_WORKFLOW: "1"
-        run: |
-          .venv\Scripts\Activate.ps1
-          . .\doc\make.bat pdf
-
       - name: Upload PDF documentation artifact
         uses: actions/upload-artifact@v4
         with:

doc/make.bat

@@ -5,7 +5,7 @@ pushd %~dp0
 REM Command file for Sphinx documentation
 
 if "%SPHINXOPTS%" == "" (
-	set SPHINXOPTS=-j auto --color
+	set SPHINXOPTS=-j auto --color -W -v
 )
 if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build

doc/source/conf.py

@@ -113,7 +113,7 @@ def copy_examples_structure(app: Sphinx, config: Config):
     logger.info(f"Copy performed.")
 
 
-def copy_script_examples(app: Sphinx, config: Config):
+def copy_script_examples(app: Sphinx, exception: Exception | None):
     """Copy root directory examples script into Sphinx application out directory.
 
     This is required to allow users to download python scripts in the admonition.
@@ -125,15 +125,18 @@ def copy_script_examples(app: Sphinx, config: Config):
     config : sphinx.config.Config
         Configuration file abstraction.
     """
-    destination_dir = Path(app.outdir, "examples").resolve()
-    logger.info(f"Copying script examples into out directory {destination_dir}.")
+    if exception is None:
+        destination_dir = Path(app.outdir, "examples").resolve()
+        logger.info(f"Copying script examples into out directory {destination_dir}.")
 
-    EXAMPLES = EXAMPLES_DIRECTORY.glob("**/*.py")
-    for example in EXAMPLES:
-        example_path = str(example).split("examples" + os.sep)[-1]
-        shutil.copyfile(example, str(destination_dir / example_path))
+        EXAMPLES = EXAMPLES_DIRECTORY.glob("**/*.py")
+        for example in EXAMPLES:
+            example_path = str(example).split("examples" + os.sep)[-1]
+            shutil.copyfile(example, str(destination_dir / example_path))
 
-    logger.info(f"Copy performed.")
+        logger.info(f"Copy performed.")
+    else:
+        logger.warning(f"An exception occured. Skipping copy_script_examples.")
 
 
 def adjust_image_path(app: Sphinx, docname, source):

doc/source/index.rst

@@ -70,7 +70,7 @@ This repository contains end-to-end embedding examples that demonstrate how to u
       :link-type: doc
 
       .. image:: examples/electrothermal/_static/icepak_logo.png
-         :alt: Icepak
+         :alt: icepak
          :width: 250px
          :height: 200px
          :align: center