Make icon links and link shortening optional #2109
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
westurner
changed the title
drammock
reviewed
Jan 27, 2025
| f"type {type(theme_options.get('icon_links'))}." | ||
| ) | ||
| if theme_options.get("icon_links") is not None: | ||
| if not isinstance(theme_options.get("icon_links", []), list): |
There was a problem hiding this comment.
I can see why on current main, setting icon_links = Nonein yourconf.pywould cause an error here. But if you don't want icon links, why not just leaveicon_links` undefined? Genuinely curious if there's a reason you need this.
| }, | ||
| ) | ||
| if icon_links is not None: | ||
| for url, icon, name in shortcuts: |
There was a problem hiding this comment.
same question as above: the code on main is fine if icon_links is not defined, it only errors if you explicitly set icon_links=None in the html_theme_options dictionary of conf.py. So why do that?
Comment on lines
+289
to
+290
| if theme_options.get("shorten_urls") is True: | ||
| app.add_post_transform(short_link.ShortenLinkTransform) |
There was a problem hiding this comment.
for this change, you'll need to add shorten_urls to src/pydata_sphinx_theme/theme/pydata_sphinx_theme/theme.conf and give it a default value (probably True for backwards compatibility)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Backwards compatible:
Not backwards compatible:
dont_shorten_urls=Trueinstead ofshorten_urls=True