Runtime verification of sphinx and jinja2 versions #381
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rossbar
force-pushed
the
sphinx-jinja-verification
branch
2 times, most recently
from
172ab84 to
ec4a310
Compare
rossbar
force-pushed
the
sphinx-jinja-verification
branch
from
ec4a310 to
9d5bb8f
Compare
|
I only marked as draft as I wasn't sure this is what people had in mind, so I wanted to make sure there was consensus before merging. |
|
Thanks @rossbar ! |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A possible mid-term solution to #380 - see discussion there for details.
Summary
For numpydoc to continue supporting unmaintained sphinx versions (sphinx<4), some form of check needs to be in place to prevent Jinja2>=3.1 from being used with sphinx<4. numpydoc 1.2.1 has pinned
Jinja2<3.1, but this is not ideal as it prevents projects that have sphinx>4.0.2 from using the latest Jinja2. One proposed solution is to remove the install requirement and replace it with a runtime environment check which raises a more informative exception message notifying numpydoc users that they are responsible for pinning Jinja2 in their projects if they wish to keep using older sphinx.