UPGRADE: Sphinx 6.x.

[marxin]

There should not be any fundamental problem with supporting Sphinx 6.x.

To do

• New myst-parser is released, which will let us test on Sphinx 6 here.
• See if tests are happy or anything broken in the output
• If not, we can merge

Closes #118

[welcome]

Thanks for submitting your first pull request! You are awesome! 🤗

If you haven't done so already, check out EBP's Code of Conduct and our Contributing Guide, as this will greatly help the review process.

Welcome to the EBP community! 🎉

[jpmckinney]

Seeing as Sphinx 6 isn't finalized or released yet, it seems prudent to wait for a release before changing this. Major Sphinx releases have a tendency to upgrade docutils, which has a tendency to break things.

[marxin]

Works for me.

[akaszynski]

Would be great to add support for this as this is blocking PyVista in pyvista/pyvista#3762.

[benjaoming]

Seeing that docutils 0.18 and 0.19 have already been released for a while, that should not be a source of issues.

Sphinx 6 removed jQuery but I can't find anywhere that sphinx-design uses this?

I don't know anything else that could raise concerns here. The release notes are available here: https://www.sphinx-doc.org/en/master/changes.html

[choldgraf]

I'm +1 on this, but we'll need to bump the versions to latest of all of the other dependencies in tests that in EBP. They tend to cap the upper version of Sphinx in each one, so I suspect that the version of Sphinx we test here is going to be 5 even if we raise the version of this package to 6.

[benjaoming]

@choldgraf you're right!

Collecting sphinx<7,>=4
  Downloading sphinx-5.3.0-py3-none-any.whl (3.2 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.2/3.2 MB 28.3 MB/s eta 0:00:00

Seems we need a new release of myst-parser to come out, Sphinx 6 was added yesterday: executablebooks/MyST-Parser#664

[codecov-commenter]

Codecov Report

Patch coverage has no change and project coverage change: +0.01 🎉

Comparison is base (6df4751) 90.02% compared to head (c4a2fb4) 90.03%.

❗ Current head c4a2fb4 differs from pull request most recent head 93ac84d. Consider uploading reports for the commit 93ac84d to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #106      +/-   ##
==========================================
+ Coverage   90.02%   90.03%   +0.01%     
==========================================
  Files          11       10       -1     
  Lines         942      933       -9     
==========================================
- Hits          848      840       -8     
+ Misses         94       93       -1     

Flag	Coverage Δ
pytests	90.03% <ø> (+0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 2 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[spoorcc]

There is a new MyST-Parser release available:
executablebooks/MyST-Parser#710 (comment)

[nicoa]

Hey, thanks for the work on this! Linking #118 for reference here, as it is closed by this PR.

[LecrisUT]

@chrisjsewell or any other collaborator. Can someone trigger the tests and/or review this?

[choldgraf]

This seems reasonable to me! I updated the MyST Parser as well because that was pinning Sphinx at myst-parser 0.18. I see that tests are happy (the 3.8 failure is because of a codecov upload error, not the test suite), so I'll merge this one!

[welcome]

Congrats on your first merged pull request in this project! 🎉


Thank you for contributing, we are very proud of you! ❤️

[LecrisUT]

@choldgraf Thank you very much 🎉. Seems that pre-commit CI needs some upgrading though?

[LecrisUT]

Any remaining fixes until version bump?

[choldgraf]

Nothing blocking, just hours in the day. If others are interested in helping to maintain, merge PRs, cut releases, etc, please let me know!

Here's a PR to cut a new release:

• RLS: v0.4.0 #127

If the tests are happy then I'll merge and release on github 👍