-
-
Notifications
You must be signed in to change notification settings - Fork 943
Make release cycle charts reusable #1708
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.
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
base: main
Are you sure you want to change the base?
Conversation
conf.py
Outdated
| html_extra_path = [ | ||
| 'include/release-cycle.svg', | ||
| 'include/release-cycle-all.svg', | ||
| ] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is this needed? Semantically, I think we should prefer static path to extra path: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_extra_path
A list of paths that contain extra files not directly related to the documentation
A
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is this needed?
So that they're served at https://devguide.python.org/release-cycle.svg
Semantically, I think we should prefer static path to extra path: sphinx-doc.org/en/master/usage/configuration.html#confval-html_extra_path
A list of paths that contain extra files not directly related to the documentation
A
Okay, so have the generate script save them to _static, and have them served at https://devguide.python.org/_static/release-cycle.svg ?
I've pushed a commit for this.
|
Would it make sense to provide light, dark, and “responsive” variants? If we decide that serving 3×2 static images, rather than 2, is worth it, I'd prefer doing the related changes myself -- I can clean up and adjust the CSS while doing that. |
|
Right now this is just for python.org which only has a light theme. No objections to making more variants in the future, and I'm happy for you to do it. What would a "responsive" variant be? The SVG is already, well, scalable :) |
Responding to the user's light/dark preference :) I've sent my suggestions here: hugovk#36 |
Right now, the release cycle SVGs are monochrome when viewed as standalone images:
This is because all the colours are defined in the website's own
.cssfile.This PR moves the colours into the SVG files themselves, except for the theme-aware overrides using things like
--color-foreground-primaryfrom Furo, needed for dark/light mode support.Also serve these images, so we can display them on https://www.python.org/downloads/ where our end users visit, and not just in the CPython developer's guide. Re: https://endoflife.date/recommendations#bad---python
Needed for PR: pythondotorg#2837
📚 Documentation preview 📚: https://cpython-devguide--1708.org.readthedocs.build/