-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Move development dependencies to dependencies page #20011
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm still a little confused about the organization. We have doc/devel/development_setup.rst
and doc/devel/dependencies.rst
. I don't see how those are distinct, and suggest they just get combined and the one removed get a redirect to the one that is kept.
.. _development-dependencies: | ||
|
||
Additional dependencies for development | ||
======================================= |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I thought we were maintaining a conda environment for these. Is that not the case? It would make development a lot easier for most folks....
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have a draft PR for this at #17096. This still needs
- check that the minimum requirements are still up-to-date. Maybe we have bumped something in between.
- a complete test in a fresh environment.
- a section in
development_setup.rst
, or rather restructuring it so that the existing docs (venv/pip) is one way and conda is an alternative. On a side note, I think that moving the dependencies in this PR actually will help with the restructuring as there is less text involved.
If anybody is interested in moving this forward, you can directly push to that PR.
These two serve different purposes. In contrast, I regard Given that we have quite complex dependencies, I find it worthwile documenting them concisely in one central place without cluttering them with installation instructions or similar. |
e310ccc
to
14de76c
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is an improvement. We can always re-arrange again later
Owee, I'm MrMeeseeks, Look at me. There seem to be a conflict, please backport manually. Here are approximate instructions:
And apply the correct labels and milestones. Congratulation you did some good work ! Hopefully your backport PR will be tested by the continuous integration and merged soon! If these instruction are inaccurate, feel free to suggest an improvement. |
I don't quite know what the backport policy is for docs.... |
Theoretically, doc changes only changing .rst files could go to 3.4-doc (which also implies backporting to the next bugfix release). However sooner or later we miss backporting some changes, so that the automatic backports will fail. In that case I give up and the change only goes to the next minor release. I don't think it's worth fix these kind of backports. |
PR Summary
Inspired by #19962 (comment).