⬆️ UPGRADE: Upgrade to support sphinx4, remove support for sphinx2 by mmcky · Pull Request #356 · executablebooks/MyST-NB

mmcky · 2021-08-30T00:12:24Z

This PR enables support for sphinx>=4 and drops support for sphinx<=2

fixes #338

Updated testing to:

test python=3.6 to python=3.9 against sphinx3 and sphinx4 release on ubuntu-latest
test python=3.9 and sphinx4 for osx-latest
test python=3.7and sphinx3 for windows-latest

This PR adds support for tracking differences between sphinx3 and sphinx4 but tracking of docutils versions in the test fixtures is not required at this stage.

mmcky · 2021-08-30T00:16:01Z

@chrisjsewell this PR has far fewer changes than #352 as it turns out there don't seem to be a huge number of sphinx specific differences in our fixture set for myst-nb. In fact only one test in test_glue.py::test_parser.

I have added a string though to conftests.py::sphinx_run to enable any future updates to either:

what software we need to track in fixtures (i.e. perhaps docutils later on)
a single reference point so they all match conventions.

mmcky · 2021-08-30T00:26:17Z

@chrisjsewell @choldgraf I reconfigured github actions a little to test all python versions for both sphinx3 and sphinx4 with the one special case for windows.

I am wondering if we should:

conduct python=3.7,3.8,3.9 testing against sphinx4 only
add in python=3.9 and sphinx4 for os x

codecov · 2021-08-30T00:27:17Z

Codecov Report

Merging #356 (9aecefb) into master (a3b2c6e) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #356   +/-   ##
=======================================
  Coverage   87.43%   87.43%           
=======================================
  Files          12       12           
  Lines        1337     1337           
=======================================
  Hits         1169     1169           
  Misses        168      168

Flag	Coverage Δ
pytests	`87.43% <ø> (ø)`

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 a3b2c6e...9aecefb. Read the comment docs.

mmcky · 2021-08-30T00:32:33Z

@chrisjsewell not sure why

tests (ubuntu-latest, 3.6, >=3,<4) Expected — Waiting for status to be reported
tests (ubuntu-latest, 3.8, >=2,<3) Expected — Waiting for status to be reported

are expected given the .github/workflows/tests.yml

chrisjsewell · 2021-08-30T00:34:49Z

.github/workflows/tests.yml

        os: [ubuntu-latest]
-        python-version: [3.6, 3.7, 3.8, 3.9]
-        sphinx: [">=3,<4"]
+        python-version: [3.7, 3.8, 3.9]


If you are deprecating python 3.6 support, then you need to update setup.cfg

and also tox.ini

ah right -- roger that.

Perhaps I won't in the case. This can be done separately if we want to do that as a project.

the endo of life is in a few months, so it is fine to do so: https://devguide.python.org/#status-of-python-branches

still not sure why

tests (ubuntu-latest, 3.8, >=2,<3) Expected — Waiting for status to be reported

is expected though. @chrisjsewell I can't see sphinx2 anywhere across the various configs.

it's part of the branch protection rules

@chrisjsewell that end of life chart is pretty great. 👍 I might open an issue to EOL python3.6 for December

it's part of the branch protection rules

Oh -- thanks I would never have checked there :-)

setup.cfg

mmcky · 2021-08-30T00:41:04Z

OK so I have updated testing to:

test python=3.6 to python=3.9 against sphinx3 and sphinx4 release on ubuntu-latest
test python=3.9 and sphinx4 for osx-latest
test python=3.7and sphinx3 for windows-latest

mmcky · 2021-08-30T01:17:57Z

@chrisjsewell do you want to be explicit about testing of docutils versions. In the current tox setup:

docutils=0.16 gets installed for py##-sphinx3 and
docutils=0.17 gets installed for py##-sphinx4

choldgraf

This in general LGTM! As long as tests are happy then I think we should go for it.

choldgraf · 2021-08-30T01:41:57Z

tests/test_glue/test_parser.sphinx4.xml

@@ -0,0 +1,169 @@
+<document source="with_glue">


Should we now expect a new one of these files for every major version of Sphinx that we support?

@choldgraf the sphinx3 is the same as the old fixture file. There is a minor difference in what sphinx includes in the xml "align='default'" is no longer specified in sphinx4

mmcky · 2021-08-30T23:00:00Z

@chrisjsewell do you want to cast an eye over this before it is merged?

mmcky · 2021-09-01T00:14:31Z

thanks @choldgraf for reviewing this. I will merge this tomorrow if there are no further comments.

choldgraf · 2021-09-02T01:31:16Z

In the meeting today I think that we agreed that it's time to merge this one and cut a release! 🚀

mmcky · 2021-09-02T01:37:03Z

Absolutely - I can do that this afternoon. Just tied up with a few other things this morning.

Upgrade to support sphinx4, remove support for sphinx2

ada2b91

mmcky mentioned this pull request Aug 30, 2021

MAIN: Enable support for Sphinx>=4 #352

Closed

4 tasks

mmcky added 2 commits August 30, 2021 10:23

update github action tests setup

9460257

reconfigure to include major tests on sphinx3 and sphinx4

7d68b54

chrisjsewell reviewed Aug 30, 2021

View reviewed changes

add back in python=3.6, add in osx-latest for py39-sphinx4

c6833b0

chrisjsewell reviewed Aug 30, 2021

View reviewed changes

setup.cfg Outdated Show resolved Hide resolved

mmcky added 3 commits August 30, 2021 10:47

FIX: fix specific test runs not to include range

853685c

Upgrade docutils pin to include 0.17

632c51e

restore testing all major python versions against sphinx3 and sphinx4

9aecefb

mmcky requested a review from chrisjsewell August 30, 2021 01:26

choldgraf approved these changes Aug 30, 2021

View reviewed changes

choldgraf mentioned this pull request Sep 1, 2021

myst_nb vs myst_parser issues #357

Open

mmcky merged commit 9f6fae2 into master Sep 2, 2021

mmcky deleted the support-sphinx4+ branch September 2, 2021 03:31

choldgraf mentioned this pull request Sep 28, 2021

UPGRADE: MyST-NB ~=0.13, Support Sphinx 4 jupyter-book/jupyter-book#1438

Closed

6 tasks

Conversation

mmcky commented Aug 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mmcky commented Aug 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mmcky commented Aug 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Aug 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

mmcky commented Aug 30, 2021

Uh oh!

chrisjsewell Aug 30, 2021

Choose a reason for hiding this comment

Uh oh!

chrisjsewell Aug 30, 2021

Choose a reason for hiding this comment

Uh oh!

mmcky Aug 30, 2021

Choose a reason for hiding this comment

Uh oh!

chrisjsewell Aug 30, 2021

Choose a reason for hiding this comment

Uh oh!

mmcky Aug 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chrisjsewell Aug 30, 2021

Choose a reason for hiding this comment

Uh oh!

mmcky Aug 30, 2021

Choose a reason for hiding this comment

Uh oh!

mmcky Aug 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mmcky commented Aug 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mmcky commented Aug 30, 2021

Uh oh!

choldgraf left a comment

Choose a reason for hiding this comment

Uh oh!

choldgraf Aug 30, 2021

Choose a reason for hiding this comment

Uh oh!

mmcky Aug 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mmcky commented Aug 30, 2021

Uh oh!

mmcky commented Sep 1, 2021

Uh oh!

choldgraf commented Sep 2, 2021

Uh oh!

mmcky commented Sep 2, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mmcky commented Aug 30, 2021 •

edited

Loading

mmcky commented Aug 30, 2021 •

edited

Loading

mmcky commented Aug 30, 2021 •

edited

Loading

codecov bot commented Aug 30, 2021 •

edited

Loading

mmcky Aug 30, 2021 •

edited

Loading

mmcky Aug 30, 2021 •

edited

Loading

mmcky commented Aug 30, 2021 •

edited

Loading

mmcky Aug 30, 2021 •

edited

Loading