Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
Collect information for setting up a development environment#19215
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Collect information for setting up a development environment#19215
Uh oh!
There was an error while loading.Please reload this page.
Conversation
doc/devel/development_setup.rst Outdated
You should set up a dedicated `virtual environment`_ to decouple your | ||
Matplotlib development from other Python and Matplotlib installations on your | ||
system. This is the environment you can safely develop and test your changes | ||
in. |
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.
maybe add a sentence like "Here we recommend thevenv
virtual environment, you may use others such as conda." (especially since you wrote the env file!)
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.
Yes. More on that will come with#17096.
7bcae21
to1fec2ae
Compare
PR Summary
It is reasonable to have all development setup information together in one place. You usually only install once, but possibly you want to directly install everything needed to run tests and build documentation as well. Thus, I find it better to list all dependencies here and only link from the documenting and testing sections (The links have been there anyway because they back-reference the general part of setting up a development environement.
This mainly rearranges existing descriptions and adapts wording a little. For sure, there could be done more (e.g. mentioning the docker image or describing how to do this in a conda environment#17096), but I'd leave these for another time because the rearrangement here is large enough already for reviewers.
Also related to#17327.