Skip to content

Make icon links and link shortening optional #2109

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 9 commits into
base: main
Choose a base branch
from
Open

Make icon links and link shortening optional #2109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7b5cedd
BUG: do not add icon links if theme_options[icon_links] is None
westurner Jan 27, 2025
2477db0
BUG: do not shorten links if theme_options['shorten_urls'] is not True
westurner Jan 27, 2025
91c3609
[pre-commit.ci] Automatic linting and formatting fixes
pre-commit-ci[bot] Jan 27, 2025
6947195
Revert "BUG: do not add icon links if theme_options[icon_links] is None"
gabalafou Jun 17, 2025
c6e83ee
respond to review by @drammock
gabalafou Jun 17, 2025
f4a03dd
Update src/pydata_sphinx_theme/__init__.py
gabalafou Jun 19, 2025
97d93c4
test for shorten_urls=False in configuration
gabalafou Jul 4, 2025
98087b5
Merge branch 'main' into make_icon_links_optional
gabalafou Jul 6, 2025
e97e91a
fix tests
gabalafou Jul 7, 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
6 changes: 5 additions & 1 deletion src/pydata_sphinx_theme/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ def update_config(app):
raise ExtensionError(
"`icon_links` must be a list of dictionaries, you provided "
f"type {type(theme_options.get('icon_links'))}."
"If you wish to disable this feature, either do not provide "
"a value (leave undefined), or set to an empty list."
)

# Set the anchor link default to be # if the user hasn't provided their own
Expand Down Expand Up @@ -282,7 +284,9 @@ def setup(app: Sphinx) -> Dict[str, str]:

app.add_html_theme("pydata_sphinx_theme", str(theme_path))

app.add_post_transform(short_link.ShortenLinkTransform)
theme_options = utils.get_theme_options_dict(app)
if theme_options.get("shorten_urls"):
app.add_post_transform(short_link.ShortenLinkTransform)

app.connect("builder-inited", translator.setup_translators)
app.connect("builder-inited", update_config)
Expand Down
1 change: 1 addition & 0 deletions src/pydata_sphinx_theme/theme/pydata_sphinx_theme/theme.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ logo_link =
surface_warnings = True
back_to_top_button = True
search_as_you_type = False
shorten_urls = True

# Template placement in theme layouts
navbar_start = navbar-logo
Expand Down
23 changes: 22 additions & 1 deletion tests/test_build.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -844,7 +844,10 @@ def test_theme_switcher(sphinx_build_factory, file_regression) -> None:

def test_shorten_link(sphinx_build_factory, file_regression) -> None:
"""Regression test for "edit on <provider>" link shortening."""
sphinx_build = sphinx_build_factory("base").build()
confoverrides = {
"html_theme_options": {"shorten_urls": True},
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not 100% sure why the default value in theme.conf isn't picked up by the test build process, but being forced to set shorten_urls to true also makes the setting more explicity.

}
sphinx_build = sphinx_build_factory("base", confoverrides=confoverrides).build()

github = sphinx_build.html_tree("page1.html").select(".github-container")[0]
file_regression.check(github.prettify(), basename="github_links", extension=".html")
Expand All @@ -853,6 +856,24 @@ def test_shorten_link(sphinx_build_factory, file_regression) -> None:
file_regression.check(gitlab.prettify(), basename="gitlab_links", extension=".html")


def test_dont_shorten_link(sphinx_build_factory, file_regression) -> None:
"""Regression test for setting shorten_urls to false ."""
confoverrides = {
"html_theme_options": {"shorten_urls": False},
}
sphinx_build = sphinx_build_factory("base", confoverrides=confoverrides).build()

github = sphinx_build.html_tree("page1.html").select(".github-container")[0]
file_regression.check(
github.prettify(), basename="github_links_not_shortened", extension=".html"
)

gitlab = sphinx_build.html_tree("page1.html").select(".gitlab-container")[0]
file_regression.check(
gitlab.prettify(), basename="gitlab_links_not_shortened", extension=".html"
)


def test_math_header_item(sphinx_build_factory, file_regression) -> None:
"""Regression test for math items in a header title."""
sphinx_build = sphinx_build_factory("base").build()
Expand Down
19 changes: 19 additions & 0 deletions tests/test_build/github_links_not_shortened.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<div class="github-container docutils container">
<p>
<a class="reference external" href="https://github.com">
https://github.com
</a>
<a class="reference external" href="https://github.com/pydata">
https://github.com/pydata
</a>
<a class="reference external" href="https://github.com/pydata/pydata-sphinx-theme">
https://github.com/pydata/pydata-sphinx-theme
</a>
<a class="reference external" href="https://github.com/pydata/pydata-sphinx-theme/pull/1012">
https://github.com/pydata/pydata-sphinx-theme/pull/1012
</a>
<a class="reference external" href="https://github.com/orgs/pydata/projects/2">
https://github.com/orgs/pydata/projects/2
</a>
</p>
</div>
40 changes: 40 additions & 0 deletions tests/test_build/gitlab_links_not_shortened.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<div class="gitlab-container docutils container">
<p>
<a class="reference external" href="https://gitlab.com">
https://gitlab.com
</a>
<a class="reference external" href="https://gitlab.com/gitlab-org">
https://gitlab.com/gitlab-org
</a>
<a class="reference external" href="https://gitlab.com/gitlab-org/gitlab">
https://gitlab.com/gitlab-org/gitlab
</a>
<a class="reference external" href="https://gitlab.com/gitlab-org/gitlab/-/issues/375583">
https://gitlab.com/gitlab-org/gitlab/-/issues/375583
</a>
<a class="reference external" href="https://gitlab.com/gitlab-org/gitlab/issues/375583">
https://gitlab.com/gitlab-org/gitlab/issues/375583
</a>
<a class="reference external" href="https://gitlab.com/gitlab-org/gitlab/-/issues/">
https://gitlab.com/gitlab-org/gitlab/-/issues/
</a>
<a class="reference external" href="https://gitlab.com/gitlab-org/gitlab/issues/">
https://gitlab.com/gitlab-org/gitlab/issues/
</a>
<a class="reference external" href="https://gitlab.com/gitlab-org/gitlab/-/issues">
https://gitlab.com/gitlab-org/gitlab/-/issues
</a>
<a class="reference external" href="https://gitlab.com/gitlab-org/gitlab/issues">
https://gitlab.com/gitlab-org/gitlab/issues
</a>
<a class="reference external" href="https://gitlab.com/gitlab-org/gitlab/-/merge_requests/84669">
https://gitlab.com/gitlab-org/gitlab/-/merge_requests/84669
</a>
<a class="reference external" href="https://gitlab.com/gitlab-org/gitlab/-/pipelines/511894707">
https://gitlab.com/gitlab-org/gitlab/-/pipelines/511894707
</a>
<a class="reference external" href="https://gitlab.com/gitlab-com/gl-infra/production/-/issues/6788">
https://gitlab.com/gitlab-com/gl-infra/production/-/issues/6788
</a>
</p>
</div>
Loading