search

Quansight-Labs / accessible-pygments

♿ Accessible pygments themes
https://quansight-labs.github.io/accessible-pygments/
BSD 3-Clause "New" or "Revised" License
12 stars 5 forks source link

Remove build artifacts from the repo #41

Closed gabalafou closed 7 months ago

gabalafou commented 9 months ago

This PR removes all of the generated HTML and CSS from the repo and refactors the build scripts.

There is perhaps an argument for committing built examples to the repo. That way a user can open the demo page from their own local repo into their browser without having to execute any build command first. But we can add that later if we want.

My goal is to make the repo easier to understand by stripping it of everything but READMEs, config files, source code, scripts, and tests.

My ultimate goal is to simplify and automate the process of updating or adding a theme. This PR helps that goal by removing steps 2, 3, and 4 from the list of steps in issue #34. The trade-off that this PR makes to achieve that goal is that the docs/index.html file can no longer be opened locally from the repo and just work (to make it work locally, developers will need to run the render_html command). Subsequent PRs will automate steps 5 and 6, so that updating a theme will involve the following steps:

  1. Update theme's style.py
  2. Run a script to update the theme's README (color contrast table and screenshot)
  3. git commit
github-actions[bot] commented 9 months ago

PR Preview Action v1.2.0 :---: :rocket: Deployed preview to https://Quansight-Labs.github.io/accessible-pygments/pr-preview/pr-41/ on branch gh-pages at 2024-03-27 12:10 UTC

gabalafou commented 9 months ago

Do we know why PR-preview (GitHub action) doesn't work?

gabalafou commented 7 months ago

Is this being done in other PR? think I saw another one with jinja templates

No, this is still an open problem. The Jinja template in the other PRs is used to generate the theme READMEs, but not the demo index.html page.