Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Automate theme README screenshots #43

Merged
merged 39 commits into from
Mar 28, 2024
Merged

Automate theme README screenshots #43

merged 39 commits into from
Mar 28, 2024

Conversation

gabalafou
Copy link
Contributor

@gabalafou gabalafou commented Mar 26, 2024 •
edited
Loading

Purpose

This PR is the final PR to fix issue #34. (Although there will probably be some cleanup PRs following this work.)

Summary of changes

  • Add Playwright to dev dependencies. (Also added setuptools, which I think should have been there all along, since it is used by the render_html script)
  • Add Playwright post-install step (playwright install) to Hatch "dev" environment config
  • Run the render_html script when the update_readme_for_theme script is called. (This regenerates the HTML samples of code syntax highlighting for a given theme, which are saved in the test/results/ directory.)
  • Use Playwright in the update README script to take a screenshot of the HTML page generated for a particular theme.

@gabalafou gabalafou requested a review from trallard March 26, 2024 14:57
gabalafou
gabalafou commented Mar 26, 2024
View reviewed changes
Copy link
Contributor Author

@gabalafou gabalafou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done self-reviewing

tests/render_html.py Outdated Show resolved Hide resolved
test/render_html.py Outdated Show resolved Hide resolved
scripts/update_readme_for_theme.py Outdated Show resolved Hide resolved
scripts/update_readme_for_theme.py Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Show resolved Hide resolved
pyproject.toml Show resolved Hide resolved
scripts/update_readme_for_theme.py Outdated Show resolved Hide resolved
test/render_html.py Outdated Show resolved Hide resolved
@trallard trallard added the type: enhancement 💅🏼 New feature or request label Mar 27, 2024
@trallard trallard requested a review from Carreau March 27, 2024 12:40
Carreau
Carreau reviewed Mar 27, 2024
View reviewed changes
Copy link
Collaborator

@Carreau Carreau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Misc comments, but I guess we should push #42 forward first to make this one smaller.

pyproject.toml Show resolved Hide resolved
pyproject.toml Show resolved Hide resolved
scripts/update_readme_for_theme.py Outdated Show resolved Hide resolved
scripts/update_readme_for_theme.py Outdated Show resolved Hide resolved
scripts/update_readme_for_theme.py Outdated Show resolved Hide resolved
scripts/update_readme_for_theme.py Outdated Show resolved Hide resolved
test/render_html.py Outdated Show resolved Hide resolved
test/render_html.py Outdated Show resolved Hide resolved
gabalafou and others added 3 commits March 27, 2024 09:19
@gabalafou @Carreau
Update a11y_pygments/utils/wcag_contrast.py
714bd98 
Co-authored-by: M Bussonnier <bussonniermatthias@gmail.com>
@gabalafou
Update a11y_pygments/utils/wcag_contrast.py
1989c7b
@gabalafou @Carreau
Update scripts/templates/README.md
e82e202 
Co-authored-by: M Bussonnier <bussonniermatthias@gmail.com>
@Carreau Carreau mentioned this pull request Mar 27, 2024
Merged
Base automatically changed from update-readme-script to main March 28, 2024 09:06
@Carreau
Copy link
Collaborator

Carreau commented Mar 28, 2024

This also picked up some conflicts.

@github-actions GitHub Actions
Copy link

PR Preview Action v1.2.0
🚀 Deployed preview to https://Quansight-Labs.github.io/accessible-pygments/pr-preview/pr-43/
on branch gh-pages at 2024-03-28 14:08 UTC

@gabalafou gabalafou merged commit 32a7cbb into main Mar 28, 2024
6 checks passed
@gabalafou gabalafou deleted the auto-shot branch March 28, 2024 14:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Carreau Carreau Carreau left review comments

@trallard trallard Awaiting requested review from trallard

Assignees
No one assigned
Labels
type: enhancement 💅🏼 New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@gabalafou @Carreau @trallard