diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 30f1396175..543cc91b08 100644 --- 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 new file mode 100644 index 0000000000..ab369c1e41 --- /dev/null +++ b/doc/changelog.d/3468.fixed.md @@ -0,0 +1 @@ +fix: add ``build cheatsheet`` as env variable within doc-build \ No newline at end of file diff --git a/doc/source/conf.py b/doc/source/conf.py index f874f6f4c7..d4e73a7a0b 100755 --- 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