Skip to content

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.

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

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
+160 −142
Open

Make release cycle charts reusable #1708

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
6b69e59
Move styles into SVG image
hugovk Nov 28, 2025
a0195fc
Put scalable vector graphics on the world wide web
hugovk Nov 28, 2025
abc7ce5
Set a font in the SVG
hugovk Nov 28, 2025
cd4f76a
Update comments
hugovk Nov 29, 2025
60d4439
Fix xmlParseEntityRef error caused by unescape ampersand
hugovk Nov 29, 2025
f271745
Save release charts to _static
hugovk Nov 29, 2025
d36cf00
Adjust standalone release chart CSS
encukou Dec 1, 2025
2f0db0b
Draw outlines and text separately
encukou Dec 2, 2025
29c0602
Set background color explicitly
encukou Dec 2, 2025
eabf2f0
Fix
encukou Dec 2, 2025
fb4e66e
Avoid :root
encukou Dec 2, 2025
4bdcd0d
Responsive colours for years
encukou Dec 2, 2025
53a698c
Light only; add background
encukou Dec 3, 2025
2c985f6
Merge pull request #36 from encukou/standalone-svg
hugovk Dec 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 0 additions & 68 deletions _static/devguide_overrides.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,8 @@
}

/* Release cycle chart */

.release-cycle-chart {
width: 100%;
}

.release-cycle-chart .release-cycle-year-line {
stroke: var(--color-foreground-primary);
stroke-width: 0.8px;
opacity: 75%;
}

.release-cycle-chart .release-cycle-year-text {
Expand All @@ -24,84 +17,23 @@

.release-cycle-chart .release-cycle-today-line {
stroke: var(--color-brand-primary);
stroke-width: 1.6px;
}

.release-cycle-chart .release-cycle-row-shade {
fill: var(--color-background-item);
opacity: 50%;
}

.release-cycle-chart .release-cycle-version-label {
fill: var(--color-foreground-primary);
}

.release-cycle-chart .release-cycle-blob {
stroke-width: 1.6px;
/* default colours, overridden below for individual statuses */
fill: var(--color-background-primary);
stroke: var(--color-foreground-primary);
}

.release-cycle-chart .release-cycle-blob-label {
/* white looks good on both light & dark */
fill: white;
}

.release-cycle-chart .release-cycle-blob-label.release-cycle-status-security,
.release-cycle-chart .release-cycle-blob-label.release-cycle-status-bugfix {
/* but use black to improve contrast for lighter backgrounds */
fill: black;
}

.release-cycle-chart .release-cycle-blob-label.release-cycle-status-end-of-life,
.release-cycle-chart .release-cycle-blob-label.release-cycle-status-prerelease,
.release-cycle-chart .release-cycle-blob-label.release-cycle-status-feature {
/* and FG when it's not in a blob */
fill: var(--color-foreground-primary);
}

.release-cycle-chart .release-cycle-status-end-of-life {
--status-bg-color: #DD2200;
--status-border-color: #FF8888;
}

.release-cycle-chart .release-cycle-status-security {
--status-bg-color: #FFDD44;
--status-border-color: #FF8800;
}

.release-cycle-chart .release-cycle-status-bugfix {
--status-bg-color: #00DD22;
--status-border-color: #008844;
}

.release-cycle-chart .release-cycle-status-prerelease {
--status-bg-color: teal;
--status-border-color: darkgreen;
}

.release-cycle-chart .release-cycle-status-feature {
--status-bg-color: #2222EE;
--status-border-color: #008888;
}

.release-cycle-chart .release-cycle-blob {
fill: var(--status-bg-color);
stroke: transparent;
}

.release-cycle-chart .release-cycle-blob-full {
fill: var(--status-bg-color);
stroke: var(--status-border-color);
}

.release-cycle-chart .release-cycle-border {
fill: transparent;
stroke: var(--status-border-color);
stroke-width: 1.6px;
}

.good pre {
border-left: 3px solid rgba(74, 182, 93, 1);
}
Expand Down
92 changes: 92 additions & 0 deletions _tools/release_cycle_template.svg.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,98 @@
class="release-cycle-chart"
viewBox="0 0 {{ diagram_width }} {{ diagram_height }}"
>
<style>
/* Embedded styles for standalone viewing */
.release-cycle-chart {
font-family: Arial, sans-serif;
width: 100%;
}
.release-cycle-year-line {
stroke: #333;
stroke-width: 0.8px;
opacity: 75%;
}
.release-cycle-year-text {
fill: #333;
}
.release-cycle-today-line {
stroke: #4B8BBE;
stroke-width: 1.6px;
}
.release-cycle-row-shade {
fill: #e0e0e0;
opacity: 50%;
}
.release-cycle-version-label {
fill: #333;
}
.release-cycle-blob {
stroke-width: 1.6px;
}
.release-cycle-blob-label {
/* white looks good on both light & dark */
fill: white;
}
.release-cycle-blob-label.release-cycle-status-security,
.release-cycle-blob-label.release-cycle-status-bugfix {
/* but use black to improve contrast for lighter backgrounds */
fill: black;
}
.release-cycle-blob-label.release-cycle-status-end-of-life,
.release-cycle-blob-label.release-cycle-status-prerelease,
.release-cycle-blob-label.release-cycle-status-feature {
fill: #333;
}
.release-cycle-status-end-of-life .release-cycle-blob,
.release-cycle-blob.release-cycle-status-end-of-life {
fill: #DD2200;
stroke: #FF8888;
}
.release-cycle-status-security .release-cycle-blob,
.release-cycle-blob.release-cycle-status-security {
fill: #FFDD44;
stroke: transparent;
}
.release-cycle-status-bugfix .release-cycle-blob,
.release-cycle-blob.release-cycle-status-bugfix {
fill: #00DD22;
stroke: transparent;
}
.release-cycle-status-prerelease .release-cycle-blob,
.release-cycle-blob.release-cycle-status-prerelease {
fill: teal;
stroke: transparent;
}
.release-cycle-status-feature .release-cycle-blob,
.release-cycle-blob.release-cycle-status-feature {
fill: #2222EE;
stroke: transparent;
}
.release-cycle-blob-full.release-cycle-status-end-of-life {
fill: #DD2200;
stroke: #FF8888;
}
.release-cycle-border.release-cycle-status-security {
fill: transparent;
stroke: #FF8800;
stroke-width: 1.6px;
}
.release-cycle-border.release-cycle-status-bugfix {
fill: transparent;
stroke: #008844;
stroke-width: 1.6px;
}
.release-cycle-border.release-cycle-status-prerelease {
fill: transparent;
stroke: darkgreen;
stroke-width: 1.6px;
}
.release-cycle-border.release-cycle-status-feature {
fill: transparent;
stroke: #008888;
stroke-width: 1.6px;
}
</style>
<defs>
<linearGradient id="release-cycle-mask-gradient-{{ id_key }}">
<stop stop-color="black" offset="0%" />
Expand Down
4 changes: 4 additions & 0 deletions conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@
"source_branch": "main",
}
html_static_path = ['_static']
html_extra_path = [
'include/release-cycle.svg',
'include/release-cycle-all.svg',
]
Copy link
Member

@AA-Turner AA-Turner Nov 29, 2025

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

Copy link
Member Author

@hugovk hugovk Nov 29, 2025

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.

html_css_files = [
'devguide_overrides.css',
]
Expand Down
Loading