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 version 6.0.0 is not compatible with myst-parser #848

Closed
arkodg opened this issue Jan 3, 2023 · 3 comments · Fixed by #1366
Closed

sphinx version 6.0.0 is not compatible with myst-parser #848

arkodg opened this issue Jan 3, 2023 · 3 comments · Fixed by #1366
Labels
kind/bug Something isn't working stale

Comments

@arkodg
Copy link
Contributor

arkodg commented Jan 3, 2023

Description:
Bumping sphinx to 6.0.0 from 5.3.0 using #841 broke docs on the main branch, since a dependent package (myst-parser) is not compatible with this version yet

make docs
===========> Running docs.clean ... 
rm -rf docs/html
mkdir -p tools/bin/sphinx-build.d
python3 -m venv tools/bin/sphinx-build.d/venv
tools/bin/sphinx-build.d/venv/bin/pip3 install -r tools/src/sphinx-build/requirements.txt || (rm -rf tools/bin/sphinx-build.d/venv; exit 1)
Collecting Sphinx==6.0.0
  Downloading sphinx-6.0.0-py3-none-any.whl (3.0 MB)
     |████████████████████████████████| 3.0 MB 4.9 MB/s 
Requirement already satisfied: myst-parser==0.18.1 in ./tools/bin/sphinx-build.d/venv/lib/python3.9/site-packages (from -r tools/src/sphinx-build/requirements.txt (line 2)) (0.18.1)
Requirement already satisfied: pyyaml in ./tools/bin/sphinx-build.d/venv/lib/python3.9/site-packages (from myst-parser==0.18.1->-r tools/src/sphinx-build/requirements.txt (line 2)) (6.0)
Requirement already satisfied: markdown-it-py<3.0.0,>=1.0.0 in ./tools/bin/sphinx-build.d/venv/lib/python3.9/site-packages (from myst-parser==0.18.1->-r tools/src/sphinx-build/requirements.txt (line 2)) (2.1.0)
Requirement already satisfied: jinja2 in ./tools/bin/sphinx-build.d/venv/lib/python3.9/site-packages (from myst-parser==0.18.1->-r tools/src/sphinx-build/requirements.txt (line 2)) (3.1.2)
ERROR: Cannot install Sphinx==6.0.0 and myst-parser==0.18.1 because these package versions have conflicting dependencies.

The conflict is caused by:
    The user requested Sphinx==6.0.0
    myst-parser 0.18.1 depends on sphinx<6 and >=4

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

Repro steps:
make docs

@arkodg arkodg added the kind/bug Something isn't working label Jan 3, 2023
@danehans
Copy link
Contributor

danehans commented Jan 4, 2023

@arkodg do you know if dependabot will create another PR to bump this dep? If so, we should keep this issue open and configure it to unmanage sphinx until myst-parser is compatible with 6.0.0.

@arkodg
Copy link
Contributor Author

arkodg commented Jan 4, 2023

@danehans #849 handles this by unmanaging it and adding a note to re-enable it once issue is fixed

@github-actions
Copy link

github-actions bot commented Feb 3, 2023

This issue has been automatically marked as stale because it has not had activity in the last 30 days.

@github-actions github-actions bot added the stale label Feb 3, 2023
arkodg added a commit to arkodg/gateway that referenced this issue Apr 25, 2023
* Renable dependabot updates since the latest modules are
compatible

Fixes envoyproxy#848

Signed-off-by: Arko Dasgupta <[email protected]>
Xunzhuo pushed a commit that referenced this issue Apr 27, 2023
Bump sphinx to v6.2.1 and myst-parser to v1.0.0

* Renable dependabot updates since the latest modules are
compatible

Fixes #848

Signed-off-by: Arko Dasgupta <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Something isn't working stale
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants