Skip to content

Test with docutils 0.18.1 #681

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

Closed
wants to merge 1 commit into from

Conversation

jarrodmillman
Copy link
Collaborator

@jarrodmillman jarrodmillman commented May 27, 2022

NOT INTENDED FOR MERGING

There is a bug using 0.18.1 with numpydoc:
numpy/numpydoc#402

I wanted to see if this project was also having issue and noticed that

pip install --upgrade --pre sphinx jinja2

only upgrades sphinx, jinja2 was already 3.1.2, and docutils stays at 0.17.1. So I created this PR to manually test.

On numpdoc, I run into the issue when doing this:

pip install --pre -r requirements/test.txt -r doc/requirements.txt

I don't think we should merge this PR, but maybe we should consider adding a similar test (i.e., testing against all prereleases of the requirements).

@jarrodmillman jarrodmillman marked this pull request as draft May 27, 2022 22:46
@choldgraf
Copy link
Collaborator

What's the reason to explicitly test docutils versions? I believe that Sphinx pins the docutils version already.

@drammock
Copy link
Collaborator

drammock commented May 28, 2022

What's the reason to explicitly test docutils versions? I believe that Sphinx pins the docutils version already.

I think because sphinx v5 uses docutils 18.1? (At least in our CIs that are using the sphinx 5 prerelease, that's the docutils version that gets pulled in)

@choldgraf
Copy link
Collaborator

But if we're testing on the pre-release of sphinx wouldn't that also pull in the latest supported docutils?

@jarrodmillman
Copy link
Collaborator Author

Sorry, I should have added a note about this PR (I just added it now).

@jarrodmillman
Copy link
Collaborator Author

I am closing this. I opened another PR where we can discuss testing on prereleases (and upgraded versions of software) #683.

@choldgraf
Copy link
Collaborator

Ahhh that indeed makes a lot of sense, I didn't realize that we wouldn't pull in the latest docutils w our current setup. Will take conversation to the other PR

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

Successfully merging this pull request may close these issues.

3 participants