executablebooks / MyST-Parser

An extended commonmark compliant parser, with bridges to docutils/sphinx
https://myst-parser.readthedocs.io
MIT License
738 stars 196 forks source link

Setup.cfg specifies too low a Sphinx version #398

Closed seddonym closed 3 years ago

seddonym commented 3 years ago

MyST-Parser is incompatible with Sphinx 3.0 (the allowed_exceptions argument was introduced in Sphinx 3.1).

sphinx-build -b html -a -E -n -W -T -v docs docs/_build'
Exit code: 2
Stdout:
    newnode = self.app.emit_firstresult(
TypeError: emit_firstresult() got an unexpected keyword argument 'allowed_exceptions'
Exception occurred:
  File "/.../.venv/lib/python3.8/site-packages/myst_parser/myst_refs.py", line 57, in run
    newnode = self.app.emit_firstresult(
TypeError: emit_firstresult() got an unexpected keyword argument 'allowed_exceptions'

I think the fix should just be to bump the Sphinx version number to >=3.1.

welcome[bot] commented 3 years ago

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
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! :tada:

choldgraf commented 3 years ago

good catch, I think this would take care of it: https://github.com/executablebooks/MyST-Parser/pull/400