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

Merged
drammock merged 9 commits into from
Sep 28, 2025
+87 −2
Merged

Make icon links and link shortening optional #2109

Changes from 1 commit
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
5 changes: 4 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 @@ -284,7 +284,10 @@ 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") is True:
app.add_post_transform(short_link.ShortenLinkTransform)

app.connect("builder-inited", translator.setup_translators)
app.connect("builder-inited", update_config)
Expand Down