-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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.
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
Fix Sphinx configuration post-update #5588
Conversation
163f651
to
8ed4430
Compare
f3acf80
to
64b3481
Compare
Thank you for the PR! The changelog has not been updated, so here is a friendly reminder to check if you need to add an entry. |
5193dd8
to
ad70aea
Compare
ad70aea
to
5fc92c9
Compare
Ubuntu version in GitHub Actions has recently been upgraded to 24.04: actions/runner-images#10636) This meant that pandoc was upgraded and it changed the way markdown is formatted by default.
Thanks GitHub for breaking workflows out of thin air.
0a90c73
to
d2eaa89
Compare
d2eaa89
to
3bb8af8
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I looked through it and most LGTM as you can read in inline comments. I'm wondering how I could simulate a release in my fork and see what the final outcome is. Is it as easy as pushing a tag to the fork and then do whatever is to do the trigger the workflow (need to read docs how to do the latter)
Fun fact: I copied the output of "releasy.py changelog" to a github release and the preview showed actual bug emojies for :bug:
- a feature not a bug! sweet! 🍭 (and now realize that this is in place since a couple of releases already haha ;-))
Anyway I think this is already good to go and let's kick out more releases soon for the real test.
I invested quite some time already trying to fix/understand the bash-completion issue. I suggest we keep it disabled as you suggested in commit 3bb8af8. It's not worth further hassle in my opinion! Am I right that we have some of the issues you mention after the runner ubuntu upgade in all open PR's? If so, that's even more a reason to live with the bash-completion issue and move on with merging this one. It's good to go in my opinion. Thanks! |
Yes, completely. Just let me know what do you think regarding removing the |
For now I'll make it colored - let me know if there's an issue and we can undo this :) |
That's absolutely fine. I don't have a strong opinion about whether we have colored syntax highlighting or the black/white style. As far as I remember I chose this style because we didn't have colors before my theme changes to the pydata theme and I liked it esthetically. Thanks for merging this quickly! I was not available yesterday for an answer. |
Adjust Sphinx configuration and release script
Changes:
source_suffix
in docs/conf.py to use dict format as required by newer Sphinxversions
pygment_light_style
->pygments_light_style
These changes ensure compatibility with newer Sphinx versions and improve the robustness
of the release script's reference parsing.
Edit:
While working on this PR GitHub decided to upgrade their linux/ubuntu runners with
Ubuntu 24.04
. Ubuntu upgrades are the worst: imagine not updating your system for 3 years and then suddenly upgrading everything to the most recent versions. At which point you start realizing that the final S in their LTS means Suffering instead of Support.We use just a few system dependencies in our builds and as expected, things broke:
libcairo2-dev
now needs to be installed for pygobject.pandoc
rst
->markdown
conversion output has changedbash
/bash-completion
upgrade, and I could not figure out why so I'm justxfail
ing that test in CI.