Fix error during linkcheck when trying to write pygments.css #2097
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
1 task
s-weigand
added a commit
to glotaran/pyglotaran-extras
that referenced
this pull request
Jan 18, 2025
It is 2025 and I'm tired of getting flash banged by our docs 😅 While the RTD theme served us for a long time, they do not offer a dark theme version. Whereas the [`pydata` theme](https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html) offers both light and dark themes as well as a more modern look in general. While working on this I found a bug when running the link checker so I added a workaround here and opened a [PR upstream](pydata/pydata-sphinx-theme#2097) to fix it. ### Change summary - [📚🎨 Change docs theme from RTD to pydata](a85457a) - [📚🎨🩹 Fix mermaid edge and marker (arrow head) color in darkmode](9eb459a) - [📚✨ Add interrogate badge](3650143) - [🚇🩹 Workaround to fix pydata_sphinx_theme error on linkcheck](f5b35f9)
drammock
reviewed
Jan 24, 2025
| @@ -99,5 +99,5 @@ def overwrite_pygments_css(app: Sphinx, exception=None): | |||
|
|
|||
| # re-write pygments.css | |||
| pygments_css = Path(app.builder.outdir) / "_static" / "pygments.css" | |||
| with pygments_css.open("w") as f: | |||
| f.write(get_pygments_stylesheet(light_theme, dark_theme)) | |||
| pygments_css.parent.mkdir(parents=True, exist_ok=True) | |||
There was a problem hiding this comment.
I think you shouldn't need parents=True here, right? Isn't app.builder.outdir guaranteed to exist?
There was a problem hiding this comment.
(also please add a comment saying something like "_static folder not guaranteed to exist during linkcheck" or similar)
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.
Hi there, I'm currently changing our docs to use your nice theme 😄
However, our CI fails during lickcheck since the parent folder where the theme tries to write
pygments.cssto does not exist during link checking.My workaround on our side is to create the expected parent path for linkcheck in our
conf.pywhich lets the CI pass again.This error didn't surface here for 2 reasons: