-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
DOC: update doc requirement #11667
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
DOC: update doc requirement #11667
Conversation
Thanks for the patch! |
The problem is that the requirements always say a minimal version. So if we put something like Anyways, isn't |
We can set the packages to a specific version in the build. This is what I am suggesting to do. We should already be doing something identical on travis to test for "old" versions of numpy. |
Isn't it better to run the doc builds against the newest available version, instead of some fixed one? The amout of work is roughly identical I'd say. As it stands you need to update the minimum version from time to time. With the suggestion of fixing the version, you would need to update the fixed version from time to time. Maybe this can be decided among core devs. I personally don't care, but with this PR I simply wanted to work within the system, not change it. If someone wants to change the system they would need to find out which packages to fix for which versions. |
a0c9bc1
to
f2cad5e
Compare
You can exclude a version with != |
We run the documentation build twice. What is typically done is one of the build runs on all the most recent version of all the packages, and the other one on the minimal version of all packages. I am suggesting moving the requirements of the circle-ci build on python 3.5 to use all the minimal requirement version, and leave the python 3.6 as it is right now, using the most recent ones. |
Sorry, I'm really no expert with yml/requirements. Does this line matplotlib/.circleci/config.yml Line 135 in edd053d
say that the minimum version should be used? Or is it that this line should be changed to actually use the minimal version? |
Milestoning as 3.0. While it's not release critical, it would be good to get this straight for 3.0. |
I'd say this is pretty straight already :-) It just documents the de facto minimal requirements for building the docs. |
moving this to 3.1 (for now) to make book keeping easier for me as I try to get 3.0 tagged today. |
@meeseeksmachine backport to v3.0.0-doc |
@meeseeksdev backport to v3.0.0-doc @jklymak ^ |
@meeseeksdev backport to v3.0.x |
…667-on-v3.0.0-doc Backport PR #11667 on branch v3.0.0-doc (DOC: update doc requirement)
PR Summary
For some reason the documentation now requires numpydoc 0.8 and sphinx-gallery 0.2. (See #11585 (comment) for what happens otherwise)
Also changing pillow minuimum version to 3.4. I'm not sure if pillow is really a requirement (it isn't for matplotlib itself, but maybe for the docs), but if it is, it needs to be >=3.4.
PR Checklist