Skip to content

Do not hardcode CSS/JS checksums #226

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

Merged
merged 1 commit into from
Oct 30, 2023
Merged

Do not hardcode CSS/JS checksums #226

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 16 additions & 16 deletions tests/test_urls.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ def test_default_settings(app, status, warning):
'<li><a href="/en/latest/index.html">Documentation overview</a><ul>',

# resources
_get_css_html_link_tag('en', 'latest', 'alabaster.css'),
_get_css_html_link_tag('en', 'latest', 'pygments.css'),
_get_css_html_link_tag(app, 'en', 'latest', 'alabaster.css'),
_get_css_html_link_tag(app, 'en', 'latest', 'pygments.css'),
'<link rel="stylesheet" href="/en/latest/_static/custom.css" type="text/css" />',
]

Expand Down Expand Up @@ -145,8 +145,8 @@ def test_urls_prefix_setting(app, status, warning):
'<img class="logo" src="/language/version/_static/logo.svg" alt="Logo"/>',

# resources
_get_css_html_link_tag('language', 'version', 'alabaster.css'),
_get_css_html_link_tag('language', 'version', 'pygments.css'),
_get_css_html_link_tag(app, 'language', 'version', 'alabaster.css'),
_get_css_html_link_tag(app, 'language', 'version', 'pygments.css'),
'<link rel="stylesheet" href="/language/version/_static/custom.css" type="text/css" />',
]

Expand Down Expand Up @@ -183,8 +183,8 @@ def test_urls_prefix_setting_none(app, status, warning):
'<img class="logo" src="/_static/logo.svg" alt="Logo"/>',

# resources
_get_css_html_link_tag('', '', 'alabaster.css'),
_get_css_html_link_tag('', '', 'pygments.css'),
_get_css_html_link_tag(app, '', '', 'alabaster.css'),
_get_css_html_link_tag(app, '', '', 'pygments.css'),
'<link rel="stylesheet" href="/_static/custom.css" type="text/css" />',
]

Expand Down Expand Up @@ -247,8 +247,8 @@ def test_custom_404_rst_source(app, status, warning):
'<li><a href="/en/latest/index.html">Documentation overview</a><ul>',

# resources
_get_css_html_link_tag('en', 'latest', 'alabaster.css'),
_get_css_html_link_tag('en', 'latest', 'pygments.css'),
_get_css_html_link_tag(app, 'en', 'latest', 'alabaster.css'),
_get_css_html_link_tag(app, 'en', 'latest', 'pygments.css'),
'<link rel="stylesheet" href="/en/latest/_static/custom.css" type="text/css" />',
]

Expand Down Expand Up @@ -350,8 +350,8 @@ def test_urls_for_dirhtml_builder(app, status, warning):
'<li class="toctree-l1"><a class="reference internal" href="/en/latest/chapter/">Chapter</a></li>',

# resources
_get_css_html_link_tag('en', 'latest', 'alabaster.css'),
_get_css_html_link_tag('en', 'latest', 'pygments.css'),
_get_css_html_link_tag(app, 'en', 'latest', 'alabaster.css'),
_get_css_html_link_tag(app, 'en', 'latest', 'pygments.css'),
'<link rel="stylesheet" href="/en/latest/_static/custom.css" type="text/css" />',
]

Expand All @@ -369,13 +369,13 @@ def test_sphinx_resource_urls(app, status, warning):

chunks = [
# Sphinx's resources URLs
_get_js_html_link_tag('en', 'latest', 'doctools.js'),
_get_js_html_link_tag(app, 'en', 'latest', 'doctools.js'),
]

if sphinx.version_info < (6, 0):
chunks.extend([
_get_js_html_link_tag('en', 'latest', 'underscore.js'),
_get_js_html_link_tag('en', 'latest', 'jquery.js'),
_get_js_html_link_tag(app, 'en', 'latest', 'underscore.js'),
_get_js_html_link_tag(app, 'en', 'latest', 'jquery.js'),
])

for chunk in chunks:
Expand All @@ -401,8 +401,8 @@ def test_toctree_urls_notfound_default(app, status, warning):
'<li class="toctree-l1"><a class="reference internal" href="/ja/default/chapter.html">Chapter</a></li>',

# resources
_get_css_html_link_tag('ja', 'default', 'alabaster.css'),
_get_css_html_link_tag('ja', 'default', 'pygments.css'),
_get_css_html_link_tag(app, 'ja', 'default', 'alabaster.css'),
_get_css_html_link_tag(app, 'ja', 'default', 'pygments.css'),
'<link rel="stylesheet" href="/ja/default/_static/custom.css" type="text/css" />',
]

Expand Down Expand Up @@ -469,7 +469,7 @@ def test_resources_from_extension(app, status, warning):
chunks = [
'<link rel="stylesheet" type="text/css" href="/en/latest/_static/css_added_by_extension.css" />',
'<link rel="stylesheet" type="text/css" href="/en/latest/_static/css_added_by_extension.css" />',
_get_js_html_link_tag('en', 'latest', 'js_added_by_extension.js'),
_get_js_html_link_tag(app, 'en', 'latest', 'js_added_by_extension.js'),
]

for chunk in chunks:
Expand Down
25 changes: 12 additions & 13 deletions tests/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import sphinx


def _get_css_html_link_tag(language, version, filename):
def _get_css_html_link_tag(app, language, version, filename):
if not language and not version:
href = '/_static/{filename}'.format(filename=filename)
else:
Expand All @@ -13,18 +13,18 @@ def _get_css_html_link_tag(language, version, filename):

if sphinx.version_info >= (7, 1):
# it requires `?v={hash}`
hashes = {
"pygments.css": "4f649999",
"alabaster.css": "039e1c02",
}
filehash = hashes.get(filename)
if sphinx.version_info < (7, 2):
from sphinx.builders.html import _file_checksum
else:
from sphinx.builders.html._assets import _file_checksum
filehash = _file_checksum(app.outdir / "_static", filename)
if filehash:
href = f"{href}?v={filehash}"

return '<link rel="stylesheet" type="text/css" href="{href}" />'.format(href=href)


def _get_js_html_link_tag(language, version, filename):
def _get_js_html_link_tag(app, language, version, filename):
if not language and not version:
src = '/_static/{filename}'.format(filename=filename)
else:
Expand All @@ -36,12 +36,11 @@ def _get_js_html_link_tag(language, version, filename):

if sphinx.version_info >= (7, 1):
# it requires `?v={hash}`
hashes = {
"documentation_options.js": "5929fcd5",
"doctools.js": "888ff710",
"sphinx_highlight.js": "dc90522c",
}
filehash = hashes.get(filename)
if sphinx.version_info < (7, 2):
from sphinx.builders.html import _file_checksum
else:
from sphinx.builders.html._assets import _file_checksum
filehash = _file_checksum(app.outdir / "_static", filename)
if filehash:
src = f"{src}?v={filehash}"

Expand Down