Add conditional doc build for branch environments

Author: AndrewSazonov

.github/workflows/docs.yaml

@@ -137,7 +137,14 @@ jobs:
       # Input: docs/ directory containing the Markdown files
       # Output: site/ directory containing the generated HTML files
       - name: Build site with MkDocs
-        run: pixi run docs-build
+        run: |
+          if [[ "${CI_BRANCH}" == "develop" || "${CI_BRANCH}" == "master" || "${CI_BRANCH}" == "main" ]]; then
+            echo "📘 Building production docs for ${CI_BRANCH}"
+            pixi run docs-build
+          else
+            echo "📗 Building local docs for ${CI_BRANCH}"
+            pixi run docs-local
+          fi
 
       # Set up the Pages action to configure the static files to be deployed
       # NOTE: The repository must have GitHub Pages enabled and configured to build using GitHub Actions

pixi.toml

@@ -177,6 +177,7 @@ docs-notebooks = 'mv tutorials/*.ipynb docs/tutorials/'
 docs-config = 'python tools/create_mkdocs_yml.py'
 docs-serve = "JUPYTER_PLATFORM_DIRS=1 PYTHONWARNINGS='ignore::RuntimeWarning' python -m mkdocs serve --dirty"
 docs-build = "JUPYTER_PLATFORM_DIRS=1 PYTHONWARNINGS='ignore::RuntimeWarning' python -m mkdocs build"
+docs-local = "pixi run docs-build --no-directory-urls"
 docs-clean = 'tools/cleanup_docs.sh'
 docs-setup = { depends-on = [
   'docs-config',