Test on sphinx 5

[jarrodmillman]

According to the 5.0.0 release plan, Sphinx 5 should be released in a few weeks:

• 5.0.0 release plan sphinx-doc/sphinx#10312

I would like to make this change to make it easier for projects that depend on MyST-Parser to test on Sphinx 5.

Would it be acceptable to change "sphinx>=3.1,<6" to "sphinx>=4,<6", since you don't test on Sphinx 3? If not, should I a test to verify that this should work on sphinx==3.1?

[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! 🎉

[jarrodmillman]

@choldgraf Would you mind approving running the CI tests for this PR? Thanks!!

[codecov]

Codecov Report

Merging #571 (20ab292) into master (3c45b7e) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #571   +/-   ##
=======================================
  Coverage   89.83%   89.83%           
=======================================
  Files          20       20           
  Lines        2116     2116           
=======================================
  Hits         1901     1901           
  Misses        215      215           

Flag	Coverage Δ
pytests	89.83% <ø> (ø)

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

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3c45b7e...20ab292. Read the comment docs.

[mmcky]

thanks @jarrodmillman I approved the CI run for you.

You may want to work with tox

https://myst-parser.readthedocs.io/en/latest/develop/contributing.html#testing

then you can define a new targeted test case with sphinx5.

MyST-Parser/tox.ini

Line 19 in 3c45b7e

[testenv:py{37,38,39,310}-sphinx{3,4}]

[choldgraf]

Also just a note that the broader practice of not capping dependencies has been discussed at the link below (though with no clear resolution yet):

executablebooks/meta#648

And I think the latest concrete proposal was here:

executablebooks/meta#648 (comment)

[chrisjsewell]

sphinx>=4,<6 is fine 👍

[chrisjsewell]

We should go through this and check any potential issues / things to change: https://www.sphinx-doc.org/en/master/extdev/deprecated.html

[bachya]

This is still needed, I think – Sphinx 5 has been released, and right now, there is no compatible version of myst.