fix: add build cheatsheet as env variable within doc-build (#3468)

* fix: add build cheatsheet as env variable within doc-build * chore: adding changelog file 3468.fixed.md * fix: precommit * fix: add suggestions Co-authored-by: German <[email protected]> * ci: auto fixes from pre-commit.com hooks. for more information, see https://pre-commit.ci * ci: retrigger CICD * feat: use false as default. Co-authored-by: Camille <[email protected]> --------- Co-authored-by: pyansys-ci-bot <[email protected]> Co-authored-by: German <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Camille <[email protected]>
ansys · Oct 7, 2024 · 24b3a13 · 24b3a13
1 parent 4c8f600
commit 24b3a13
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 3 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -34,6 +34,7 @@ env:
   MAPDL_PACKAGE: ghcr.io/ansys/mapdl
   ON_CI: True
   PYTEST_ARGUMENTS: '-vvv -ra --durations=10 --maxfail=3 --reruns 3 --reruns-delay 4 --cov=ansys.mapdl.core --cov-report=html'
+  BUILD_CHEATSHEET: True
 
   # Following env vars when changed will "reset" the mentioned cache,
   # by changing the cache file name. It is rendered as ...-v%RESET_XXX%-...

diff --git a/doc/changelog.d/3468.fixed.md b/doc/changelog.d/3468.fixed.md
@@ -0,0 +1 @@
+fix: add ``build cheatsheet`` as env variable within doc-build
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -311,13 +311,17 @@
         "json_url": f"https://{cname}/versions.json",
         "version_match": switcher_version,
     },
-    "cheatsheet": {
+}
+
+BUILD_CHEATSHEET = os.environ.get("BUILD_CHEATSHEET", "false").lower() == "true"
+
+if BUILD_CHEATSHEET:
+    html_theme_options["cheatsheet"] = {
         "file": "cheat_sheet/cheat_sheet.qmd",
         "title": "PyMAPDL cheat sheet",
         "version": f"v{version}",
         "pages": ["getting_started/learning"],
-    },
-}
+    }
 
 html_context = {
     "display_github": True,  # Integrate GitHub
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		fix: add ``build cheatsheet`` as env variable within doc-build