CHORE: Remove Quarto installation from CI workflows and enable cheatsheet option in documentation build#7575
Merged
Samuelopez-ansys merged 3 commits intomainfrom Apr 24, 2026
Merged
Conversation
|
All Contributor License Agreement (CLA) signatures have been captured successfully. Thanks for contributing! |
…heet option in documentation build
306ceb3 to
4e98d2c
Compare
7445b2e to
c8370c7
Compare
Samuelopez-ansys
approved these changes
Apr 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates the documentation build process in the CI workflows to improve how the Quarto dependency is managed and to make the cheatsheet feature configurable. The main changes involve removing explicit Quarto installation steps and instead relying on the
needs-quartoflag in the documentation build action. This was introduced in #7331, but it's not needed anymore. Additionally, an environment variable is introduced to optionally include the cheatsheet in the documentation.Documentation build process improvements:
.github/workflows/ci-release.yml,.github/workflows/ci_cd.yml, and.github/workflows/nightly-docs.yml, streamlining the workflow and reducing redundancy. [1] [2] [3]needs-quartoinput totruein the documentation build steps of the affected workflows, ensuring Quarto is installed only when required by the action. [1] [2]Cheatsheet configurability:
PYAEDT_DOC_BUILD_CHEATSHEETenvironment variable to.github/workflows/ci_cd.yml, allowing the cheatsheet to be included or excluded from the documentation build based on this setting.doc/source/conf.pyto conditionally add the cheatsheet tohtml_theme_optionsonly ifPYAEDT_DOC_BUILD_CHEATSHEETis not set to"False".## DescriptionPlease provide a brief description of the changes made in this pull request.
Checklist