Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sphinx 6 support #660

Closed
tony opened this issue Dec 29, 2022 · 9 comments · Fixed by #664
Closed

Sphinx 6 support #660

tony opened this issue Dec 29, 2022 · 9 comments · Fixed by #664
Labels
bug Something isn't working

Comments

@tony
Copy link

tony commented Dec 29, 2022

Describe the bug

context
When I do poetry update with myst-parser = "*' with sphinx = "*" (at

expectation
I expected myst-parser to stay at the latest version with sphinx 6.0, e.g.

❯ poetry install
Installing dependencies from lock file

Package operations: 0 install, 1 updates, 0 removals

  • Updating sphinx (5.3.0 -> 6.0.0)

bug
But instead, myst-parser is downgraded to 0.3.2
Here's an error message I ran into...

❯ poetry install
Installing dependencies from lock file

Package operations: 1 install, 2 updates, 0 removals

  • Installing mistletoe-ebp (0.8.2)
  • Updating sphinx (5.3.0 -> 6.0.0)
  • Updating myst-parser (0.18.1 -> 0.3.2)

problem
This is a problem for people upgrading to sphinx 6.0, released 5 hours ago - Sphinx docs, Release notes

It's due to <6 being pinned:

"sphinx>=4,<6",

Reproduce the bug

Update sphinx to 6.x whem myst-parser is at 0.18.1

List your environment

❯ python -V
Python 3.11.0

❯ poetry self --version
Poetry (version 1.3.1)

 ❯ pip show sphinx
Name: Sphinx
Version: 5.3.0
Summary: Python documentation generator
Home-page:
Author:
Author-email: Georg Brandl <georg@python.org>
License:
Requires: alabaster, babel, docutils, imagesize, Jinja2, packaging, Pygments, requests, snowballstemmer, sphinxcontrib-applehelp, sphinxcontrib-devhelp, sphinxcontrib-htmlhelp, sphinxcontrib-jsmath, sphinxcontrib-qthelp, sphinxcontrib-serializinghtml
Required-by: furo, myst-parser, sphinx-argparse, sphinx-autobuild, sphinx-basic-ng, sphinx-copybutton, sphinx_autodoc_typehints, sphinx_inline_tabs, sphinxext-opengraph, sphinxext-rediraffe

❯ pip show myst-parser
Name: myst-parser
Version: 0.18.1
Summary: An extended commonmark compliant parser, with bridges to docutils & sphinx.
Home-page:
Author:
Author-email: Chris Sewell <chrisj_sewell@hotmail.com>
License:
Requires: docutils, jinja2, markdown-it-py, mdit-py-plugins, pyyaml, sphinx, typing-extensions
Required-by: gp-libs
@tony tony added the bug Something isn't working label Dec 29, 2022
@welcome
Copy link

welcome bot commented Dec 29, 2022

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

@staticdev
Copy link

I have an issue on my CI/CD when trying to upgrade to Sphinx 6:

sphinx-build docs docs/_build
Running Sphinx v6.0.0

Exception occurred:
  File "/home/runner/work/human-readable/human-readable/.nox/docs-build/lib/python3.11/site-packages/myst_parser/docutils_renderer.py", line 20, in <module>
    import yaml
ModuleNotFoundError: No module named 'yaml'
The full traceback has been saved in /tmp/sphinx-err-ua89pk6_.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
nox > Command sphinx-build docs docs/_build failed with exit code 2
nox > Session docs-build failed.
Error: Process completed with exit code 1.

More on: https://github.com/staticdev/human-readable/actions/runs/3804136558/jobs/6471114085

@chrisjsewell
Copy link
Member

FYI, I yanked all old version of myst-parser, with no sphinx pinnings, from PyPI, to stop any unexpected downgrading

@barrelful
Copy link

Please @chrisjsewell can you create a new release so that we can upgrade sphinx in our projects?

@eeintech
Copy link

Please @chrisjsewell can you create a new release so that we can upgrade sphinx in our projects?

I second that request, thanks!

@kloczek
Copy link

kloczek commented Feb 1, 2023

+1

@danyeaw
Copy link

danyeaw commented Mar 4, 2023

I saw that v0.19.0 that fixes this is now out, thanks for the release!

@chrisjsewell
Copy link
Member

Thanks!

@eeintech
Copy link

eeintech commented Mar 6, 2023

Excellent! Thanks 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants