Allow using Sphinx 4

[vberlier]

Summary

Right now sphinx>=2,<4 in setup.cfg makes it impossible to use myst-nb with Sphinx 4. myst-parser upgraded to Sphinx 4 recently executablebooks/MyST-Parser#390.

Tasks to complete

• Try removing the Sphinx to <5 here
  https://github.com/executablebooks/MyST-NB/blob/master/setup.cfg#L51
  and bump myst-parser to the latest version here:
  https://github.com/executablebooks/MyST-NB/blob/master/setup.cfg#L47
• Run tests and make changes needed to make them pass
• Merge in, then we should cut a new release

[welcome]

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.

If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).

Welcome to the EBP community! 🎉

[choldgraf]

Indeed - the next step to get this is to update the MyST Parser dependency, which will bring support for Sphinx 4 when that happens (https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md#0150---2021-06-13). There might need to be some other changes too though.

[vberlier]

Just checking in. Is there anything we can do to help move this forward?

[0xMashiro]

Any progress? 👀

[chrisjsewell]

Well myst-parser is updated, so this should now work in principle

[0xMashiro]

Well myst-parser is updated, so this should now work in principle

Cool. I will have a try and give some feedback asap.

[chrisjsewell]

Note we would want myst-parser~=0.15.1

[chrisjsewell]

A notable potential change, would be to set dmath_double_inline=True as standard, to mirror the current Jupyter Notebook render behaviour

[0xMashiro]

INFO: pip is looking at multiple versions of sphinx-togglebutton to determine which version is compatible with other requirements. This could take a while.
INFO: This is taking longer than usual. You might need to provide the dependency resolver with stricter constraints to reduce runtime. If you want to abort this run, you can press Ctrl + C to do so. To improve how pip performs, tell us what happened here: https://pip.pypa.io/surveys/backtracking

When I add mystnb and myst-parser into my requirements.txt file, it will take a long time to determine other packages' version. It that means I have to use specific version for those package?

sphinx>=4.0
sphinx-intl
sphinxcontrib-mermaid>=0.7
sphinx-copybutton
sphinx-tabs
sphinx-togglebutton
sphinx-panels
jieba
ipython
recommonmark
nbsphinx
beautifulsoup4

[0xMashiro]

MyST-NB/setup.cfg

Line 51 in c98d432

sphinx>=2,<4

it was required that sphinx>=2,<4

The conflict is caused by:
    The user requested sphinx>=4.0
    sphinx-copybutton 0.4.0 depends on sphinx>=1.8
    sphinx-tabs 3.1.0 depends on sphinx<5 and >=2
    sphinx-togglebutton 0.2.3 depends on sphinx
    sphinx-panels 0.6.0 depends on sphinx<5 and >=2
    myst-nb 0.12.3 depends on sphinx<4 and >=2

To fix this you could try to:
1. loosen the range of package versions you've specified
2. remove package versions to allow pip attempt to solve the dependency conflict

[chrisjsewell]

it was required that sphinx>=2,<4

oh no what I mean is that it should work with the change to myst-nb, to sphinx>=2,<5

[chrisjsewell]

but yeh it won't work yet for the current published version

[choldgraf]

any chance that @mmcky or @AakashGfude would be able to tackle this one? If we can get MyST-NB to Sphinx 4, then we can also get sphinx-book-theme to Sphinx 4, and then Jupyter Book to Sphinx 4!