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 READMEs #42

Merged
merged 21 commits into from
Mar 28, 2024
Merged

Automate theme READMEs #42

merged 21 commits into from
Mar 28, 2024

Conversation

gabalafou
Copy link
Contributor

@gabalafou gabalafou commented Feb 23, 2024 •
edited
Loading

This PR is the second PR in a series to address #34.

This PR:

  • Adds a new Python script to the repo under scripts/ to generate theme READMEs (in particular the contrast table in the README)
    • Also adds the command to the Hatch "dev" environment
  • Updates each theme's README with the script
  • Renames two screenshots for consistency
  • Adds some color helpers
  • Excludes the scripts folder from the PyPI distribution and from the "find all themes" function
  • Updates the docs with instructions about how to run the script

@github-actions GitHub Actions
Copy link

github-actions bot commented Feb 23, 2024 •
edited
Loading

PR Preview Action v1.2.0
🚀 Deployed preview to https://Quansight-Labs.github.io/accessible-pygments/pr-preview/pr-42/
on branch gh-pages at 2024-03-27 15:00 UTC

gabalafou
gabalafou commented Feb 23, 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.

I left a bunch of notes and questions for the reviewer.

scripts/templates/README.md Outdated Show resolved Hide resolved
a11y_pygments/a11y_dark/style.py 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
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
gabalafou
gabalafou commented Feb 23, 2024
View reviewed changes
scripts/templates/README.md Outdated Show resolved Hide resolved
scripts/templates/README.md Outdated Show resolved Hide resolved
@gabalafou gabalafou changed the title Add script to update theme READMEs Automate theme READMEs Feb 23, 2024
@gabalafou gabalafou mentioned this pull request Mar 5, 2024
Merged
@gabalafou gabalafou mentioned this pull request Mar 26, 2024
Merged
@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:41
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.

First quick review, from a first read, I haven't looked too deep in the project, but hope this will unblock you.

a11y_pygments/a11y_dark/README.md Show resolved Hide resolved
a11y_pygments/a11y_dark/README.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
scripts/templates/README.md Outdated Show resolved Hide resolved
scripts/update_readme_for_theme.py Outdated Show resolved Hide resolved
a11y_pygments/utils/wcag_contrast.py Outdated Show resolved Hide resolved
a11y_pygments/utils/wcag_contrast.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/templates/README.md Outdated Show resolved Hide resolved
@gabalafou @Carreau
Update a11y_pygments/utils/wcag_contrast.py
714bd98 
Co-authored-by: M Bussonnier <bussonniermatthias@gmail.com>
gabalafou and others added 3 commits March 27, 2024 09:22
@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>
@gabalafou @Carreau
Update CONTRIBUTING.md
0be052b 
Co-authored-by: M Bussonnier <bussonniermatthias@gmail.com>
@gabalafou gabalafou mentioned this pull request Mar 27, 2024
Open
Carreau
Carreau approved these changes Mar 28, 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.

Looks good, let's get that in and iterate later if necessary.

a11y_pygments/a11y_dark/README.md Show resolved Hide resolved
scripts/update_theme_docs.py Show resolved Hide resolved
@Carreau Carreau merged commit 4f561e7 into main Mar 28, 2024
6 checks passed
@Carreau Carreau deleted the update-readme-script branch March 28, 2024 09:06
@gabalafou gabalafou mentioned this pull request Mar 28, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Carreau Carreau Carreau approved these changes

@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