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
s-weigand
force-pushed
the
make-sure-static-folder-exists-before-writing-pygments-css
branch
from
068a616 to
24014eb
Compare
Coverage report
Click to see where and how coverage changed
This report was generated by python-coverage-comment-action |
||||||||||||||||||||||||
The parent app.builder.outdir is ensured to exist by the Sphinx app instance
s-weigand
force-pushed
the
make-sure-static-folder-exists-before-writing-pygments-css
branch
from
24014eb to
07b0588
Compare
1 task
s-weigand
added a commit
to glotaran/pyglotaran-extras
that referenced
this pull request
Mar 1, 2025
Today I found that our docs are broken due to a bug when building PDFs. This PR changes the [pydata-sphinx-theme](https://github.com/pydata/pydata-sphinx-theme) from the published upstream project to a branch on my for including the following fixes: - pydata/pydata-sphinx-theme#2097 - pydata/pydata-sphinx-theme#2076 I also went ahead and removed the workaround on our side since it isn't needed with the fix on my fork in place. ### Change summary - [📚🩹 Use fixed pydata-sphinx-theme from fork](5f3bedf) - [🚇🩹 Setup docs env same as on RTD](365899d)
trallard
approved these changes
Mar 4, 2025
trallard
approved these changes
Mar 4, 2025
s-weigand
deleted the
make-sure-static-folder-exists-before-writing-pygments-css
branch
gabalafou
pushed a commit
to gabalafou/pydata-sphinx-theme
that referenced
this pull request
Mar 10, 2025
…2097) Hi there, I'm currently changing our docs to use your nice theme 😄 However, [our CI fails during lickcheck](https://github.com/s-weigand/pyglotaran-extras/actions/runs/12713637790/job/35441962465) since the parent folder where the theme tries to write `pygments.css` to does not exist during link checking. ```py Extension error (pydata_sphinx_theme.pygments): Handler <function overwrite_pygments_css at 0x7f93feb0e4d0> for event 'build-finished' threw an exception (exception: [Errno 2] No such file or directory: '/home/runner/work/pyglotaran-extras/pyglotaran-extras/docs/_build/linkcheck/_static/pygments.css') make: *** [Makefile:25: linkcheck] Error 2 make: Leaving directory '/home/runner/work/pyglotaran-extras/pyglotaran-extras/docs' ``` My workaround on our side is to [create the expected parent path for linkcheck](https://github.com/s-weigand/pyglotaran-extras/blob/f5b35f98e63e68dee73b347f175ee6c7abfe35f0/docs/conf.py#L27-L29) in our `conf.py` which [lets the CI pass again](https://github.com/s-weigand/pyglotaran-extras/actions/runs/12844533235/job/35817635012). This error didn't surface here for 2 reasons: - Linkchecking detects broken links, causing the function to [exit early](https://github.com/pydata/pydata-sphinx-theme/blob/d76892d437e3c0dc8a059741a84afbd6cc458509/src/pydata_sphinx_theme/pygments.py#L63) - The [HTML build folder is passed to linkcheck](https://github.com/pydata/pydata-sphinx-theme/blob/d76892d437e3c0dc8a059741a84afbd6cc458509/tox.ini#L44) --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Tania Allard <[email protected]>
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: