Skip to content
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

Merged
merged 6 commits into from
Jan 19, 2025
Merged

Conversation

snejus
Copy link
Member

@snejus snejus commented Jan 12, 2025

Adjust Sphinx configuration and release script

Changes:

  • Update source_suffix in docs/conf.py to use dict format as required by newer Sphinx
    versions
  • Fix typo in theme config: pygment_light_style -> pygments_light_style
  • Improve release script to handle Sphinx intersphinx output formatting:
    • Replace tabs with spaces for consistent parsing
    • Add reference to sphinx.ext.intersphinx command in docstring
    • Update line parsing to match space-indented format
  • Restructure CI workflow to ensure relevant dependencies are installed and changelog formatting is tested.

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 changed
  • Completion tests are unhappy about bash / bash-completion upgrade, and I could not figure out why so I'm just xfailing that test in CI.

@snejus snejus self-assigned this Jan 12, 2025
@snejus snejus force-pushed the adjust-sphinx-post-update branch from 163f651 to 8ed4430 Compare January 12, 2025 01:11
@snejus snejus force-pushed the adjust-sphinx-post-update branch from f3acf80 to 64b3481 Compare January 12, 2025 04:51
@snejus snejus marked this pull request as ready for review January 12, 2025 04:53
Copy link

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.

@snejus snejus requested a review from Serene-Arc January 12, 2025 04:53
@snejus snejus force-pushed the adjust-sphinx-post-update branch from 5193dd8 to ad70aea Compare January 12, 2025 05:09
@snejus snejus force-pushed the adjust-sphinx-post-update branch from ad70aea to 5fc92c9 Compare January 12, 2025 05:12
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.
@snejus snejus force-pushed the adjust-sphinx-post-update branch 5 times, most recently from 0a90c73 to d2eaa89 Compare January 13, 2025 22:36
@snejus snejus force-pushed the adjust-sphinx-post-update branch from d2eaa89 to 3bb8af8 Compare January 13, 2025 22:48
@JOJ0 JOJ0 self-requested a review January 15, 2025 06:35
Copy link
Member

@JOJ0 JOJ0 left a 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.

docs/conf.py Outdated Show resolved Hide resolved
extra/release.py Show resolved Hide resolved
extra/release.py Show resolved Hide resolved
extra/release.py Show resolved Hide resolved
test/test_ui.py Show resolved Hide resolved
docs/conf.py Show resolved Hide resolved
@JOJ0
Copy link
Member

JOJ0 commented Jan 18, 2025

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!

@snejus
Copy link
Member Author

snejus commented Jan 18, 2025

Am I right that we have some of the issues you mention after the runner ubuntu upgade

Yes, completely. Just let me know what do you think regarding removing the "bw" colors configuration to introduce coloring to the code blocks and we go ahead with the merge!

@snejus
Copy link
Member Author

snejus commented Jan 19, 2025

For now I'll make it colored - let me know if there's an issue and we can undo this :)

@snejus snejus removed the request for review from Serene-Arc January 19, 2025 00:31
@snejus snejus merged commit f409741 into master Jan 19, 2025
13 checks passed
@snejus snejus deleted the adjust-sphinx-post-update branch January 19, 2025 01:06
@JOJ0
Copy link
Member

JOJ0 commented Jan 19, 2025

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants