Fix terminal animation generation in docs build #451
Merged
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This pull request fixes an issue with the terminal animation generation used in the docs build by updating the input options and ensuring the docs build is executed as part of the tests workflow.
- Added a new tuple for the testing framework input in the terminal animation generation script.
- Updated the tests workflow by removing docs exclusion and adding a documentation build step.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/scripts/generate-termynal.py | Adds the missing testing framework input for terminal animation. |
| .github/workflows/tests.yml | Updates workflow configuration to trigger docs build on changes. |
Comments suppressed due to low confidence (1)
.github/workflows/tests.yml:43
- Verify that the 'make docs' command returns a failing status code in case of documentation build errors, ensuring that the docs build step properly enforces build integrity.
- name: Build documentation
pjbull
approved these changes
May 2, 2025
chrisjkuch
force-pushed
the
cjk-docs-tests
branch
from
20dadc0 to
0ffcf9f
Compare
pjbull
temporarily deployed
to
cjk-docs-tests - Cookiecutter Data Science PR #451
Render
Destroyed
proinsias
added a commit
to proinsias/cookiecutter-data-science-proinsias
that referenced
this pull request
Nov 3, 2025
* upstream/master: (24 commits) Add poetry as an env manager (drivendataorg#460) Support pixi as environment manager (drivendataorg#459) Docs: Add guidelines for contributing and requesting tools (drivendataorg#456) Fix terminal animation generation in docs build (drivendataorg#451) Fix failing pipenv installation on Windows GH actions runners (drivendataorg#453) Fix typo in using-the-template.md (drivendataorg#448) Bump to v2.2.0 [skip ci] Update HISTORY.md [skip ci] Add option for tests (drivendataorg#447) Resolve python version to work with compatible operator (drivendataorg#446) Add pyproject.toml as a dependencies file option (drivendataorg#436) Make PyPI badges links to PyPI (drivendataorg#440) Update to version v2.1.0 (drivendataorg#438) Add back isort configuration that was removed in drivendataorg#387 (drivendataorg#439) add badges to readme and docs homepage (drivendataorg#434) Added support for the uv package and project manager (drivendataorg#408) Add ruff as default linting + formatting option (drivendataorg#387) Add PyTest IDs for better readability and filtering (drivendataorg#409) prepare for 2.0.1 release by bumping version in pyproject.toml and updating change log (drivendataorg#422) Fix pre-prompt ccds version error (drivendataorg#426) ...
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.
When we added testing frameworks to the option set (#447) we did not update the terminal animation inputs so the last one was missing. This made the build fail because we
assertthat all options are present in the generated animation.To prevent us missing this in the future, I've added building the docs to the
testsworkflow so that we'll fail if the docs do not properly generate.