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

Bump version MyST-parser // Sphinx >= 6 #493

Closed
miili opened this issue Apr 14, 2023 · 10 comments
Closed

Bump version MyST-parser // Sphinx >= 6 #493

miili opened this issue Apr 14, 2023 · 10 comments
Labels
bug Something isn't working

Comments

@miili
Copy link

miili commented Apr 14, 2023

Describe the bug

It is time to upgrade to Sphinx >= 6. 👋🏻

Reproduce the bug

Add conflicting project dependencies 💥

[project.optional-dependencies]
docs = [
  "myst-nb>=0.17.1",
  "sphinx>=6.1.3", # <-- Banger
  "semver>=3.0.0",
  "furo>=2023.3.27",
  "sphinx-copybutton>=0.5.1",
  "sphinx-design>=0.4.1",
]

List your environment

No response

@miili miili added the bug Something isn't working label Apr 14, 2023
@welcome
Copy link

welcome bot commented Apr 14, 2023

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

@tupui
Copy link

tupui commented Apr 14, 2023

Hi folks 👋 Are there any reasons for the upper pins in the dependencies? We recently added this package to SciPy's doc and it's limiting us.

@tupui
Copy link

tupui commented May 3, 2023

And Sphinx 7 is just out.

@rossbar
Copy link
Contributor

rossbar commented May 13, 2023

Hi folks wave Are there any reasons for the upper pins in the dependencies? We recently added this package to SciPy's doc and it's limiting us.

I'd like to second this - NetworkX would like to adopt myst-nb into our main docs - see networkx/networkx#5221 (we already use myst-nb extensively in nx-guides). The primary issue we're running into is related to the upper bound pins. FWIW I've tested the NX doc builds locally with both sphinx 6 and sphinx 7 with myst-nb 0.17.2 and had no problems, so at least for this single case the pins are overly conservative.

I know this has been discussed elsewhere in the past (maybe in the executablebooks/meta repo?) and I also realize a local test from a single downstream consumer is not something that should dictate policy 🙃. I just want to provide another data point!

@LecrisUT
Copy link
Contributor

LecrisUT commented Jun 17, 2023

👍 instead of having upper pins in the pyproject.toml, just run CIs on all major releases, then pin the version when errors are detected. Especially as dependabot PRs are not being merged or addressed. At the very least, if you are going to pin the requirements in the dependencies, have a CI for testing newer releases as experimental tests.

The pinning in the [testing] dependencies is just hell to detangle

@mforbes
Copy link

mforbes commented Jun 18, 2023

I have been having similar issues. I recommend reading Henry Schreiner's post about why upper-bound version constraints should be used very sparingly, and only when really needed.

@tupui
Copy link

tupui commented Jun 19, 2023

@chrisjsewell do you have time to have a look into this issue? Seems like a few folks are blocked.

@LecrisUT
Copy link
Contributor

See #479 (comment). I think another maintainer is needed
@choldgraf, @Yoshanuikabundi, @aleivag have done some work detangling and addressing the tests. It would be great if their PRs can get merged, then #524 would address that issue together with #479.

@OriolAbril
Copy link
Contributor

This can be closed now

@bsipocz
Copy link
Collaborator

bsipocz commented Sep 19, 2024

Dependencies don't have upper pins any more, and I'm working on removing the remaining ones from the test/docs extras, too.

@bsipocz bsipocz closed this as completed Sep 19, 2024
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

No branches or pull requests

7 participants