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 update #388

Closed
ahwagner opened this issue Mar 24, 2022 · 2 comments
Closed

Sphinx update #388

ahwagner opened this issue Mar 24, 2022 · 2 comments

Comments

@ahwagner
Copy link
Member

Yep. Looks like Sphinx 4.x would be insulated against the change BTW: sphinx-doc/sphinx@e5c905c.

Originally posted by @jmarshall in #387 (comment)

@ahwagner
Copy link
Member Author

Drawing this conversation from the bugfix introduced in #387.

To recap the issue, the jinja2 package was recently updated to 3.1.0. The dev team takes a hardline approach to versioning: their version means what they want it to mean, and it definitely doesn't follow semantic versioning practices. In a way it's cool that the team is taking that stance as it reinforces best practices like dependency version pinning, but it does break from what is (in my view) widely held conventions about major/minor/patch components to a version. I know in VRS we have gone to great pains to keep every minor version increment backwards compatible, and our upcoming maturity model (branch) is designed to provide yet further guidance and communication about VRS data classes.

It seems like we're getting to the point where it is worthwhile to upgrade to Sphinx 4.x. The Sphinx devs are no longer maintaining 3.x and we are likely to see additional disruptions down the line from similar versioning non-conformists in the Sphinx dependency tree. We should revisit what it will take to update our site to the 4.x series.

Copy link

github-actions bot commented Jan 9, 2024

This issue was marked stale due to inactivity.

@github-actions github-actions bot added the Stale See .github/workflows/stale.yml label Jan 9, 2024
@ahwagner ahwagner removed the Stale See .github/workflows/stale.yml label Jan 9, 2024
@ahwagner ahwagner closed this as completed Mar 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant