Thanks to visit codestin.com
Credit goes to github.com

Skip to content

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

Merged
merged 1 commit into from
Apr 26, 2021

Conversation

timhoffm
Copy link
Member

PR Summary

Inspired by #19962 (comment).

@timhoffm timhoffm added this to the v3.4.2 milestone Apr 18, 2021
Copy link
Member

@jklymak jklymak left a 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
=======================================
Copy link
Member

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....

Copy link
Member Author

@timhoffm timhoffm Apr 18, 2021

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.

@timhoffm
Copy link
Member Author

timhoffm commented Apr 18, 2021

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.

These two serve different purposes. development_setup is a guide how to set up everything for development. Part of this setup is installing additional dependencies. I anticipate that this guide will be extended for setting up via a conda recipe #17096 or docker. Then, manual installation of dependencies is just one way (and maybe not even the preferred one), and it's ok to just link to the dependencies you need.

In contrast, I regard dependencies is as a reference. It documents all our dependencies. Some of them are runtime dependencies (which are also linked from the regular installation guide, which in turn does only need them when you want to install them manually, and not via pip/conda etc.). Additional dependencies are needed for development.

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.

Copy link
Member

@jklymak jklymak left a 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

@jklymak jklymak merged commit 93e716d into matplotlib:master Apr 26, 2021
@lumberbot-app
Copy link

lumberbot-app bot commented Apr 26, 2021

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
$ git checkout v3.4.x
$ git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
$ git cherry-pick -m1 93e716de372a8d6e95f999ce60ea8965d1488c4c
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
$ git commit -am 'Backport PR #20011: Move development dependencies to dependencies page'
  1. Push to a named branch :
git push YOURFORK v3.4.x:auto-backport-of-pr-20011-on-v3.4.x
  1. Create a PR against branch v3.4.x, I would have named this PR:

"Backport PR #20011 on branch v3.4.x"

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.

@jklymak
Copy link
Member

jklymak commented Apr 26, 2021

I don't quite know what the backport policy is for docs....

@timhoffm timhoffm modified the milestones: v3.4.2, v3.5.0 Apr 26, 2021
@timhoffm timhoffm deleted the doc-dependencies branch April 26, 2021 20:58
@timhoffm
Copy link
Member Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants