Skip to content

Additional details on VS install on installation page #23000

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
May 8, 2022

Conversation

23ccozad
Copy link
Contributor

@23ccozad 23ccozad commented May 7, 2022

PR Summary

Originally from an issue we resolved in Gitter as I was building from source. The docs currently don't specify which parts of Visual Studio that Windows users need when installing matplotlib from source. This PR adds this information to the docs, and also provides a link to a page from which VS can be downloaded.

PR Checklist

Tests and Styling

  • [N/A] Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • [N/A] New features are documented, with examples if plot related.
  • [N/A] New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • [N/A] API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

The addition to this page informs Windows users building their development environment that they will need to ensure specific Visual Studio workloads are installed.
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.

You can also join us on gitter for real-time discussion.

For details on testing, writing docs, and our review process, please see the developer guide

We strive to be a welcoming and open project. Please follow our Code of Conduct.

@23ccozad 23ccozad marked this pull request as ready for review May 7, 2022 02:01
@tacaswell tacaswell added this to the v3.5-doc milestone May 7, 2022
@tacaswell
Copy link
Member

Thank you @23ccozad !

This reads correctly to me, but I do not have a windows machine (or develop on windows regularly) so lack the expertise to actually review this....

Copy link
Contributor

@andrew-fennell andrew-fennell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

I did a clean install on a Windows machine. I attempted to build without the packages that you specified and ran into the same errors. I installed the packages and it was able to build.

The next step to getting this merged is waiting for 2 maintainers with write access to approve this PR. For what it's worth, I approve!

@andrew-fennell
Copy link
Contributor

There is a discrepancy in the naming of "C++ CMake tools for Windows" in previous version of Visual Studio (such as Visual Studio 2017).

However, if someone is going to install Visual Studio for the first time, they are likely downloading the latest version, so I don't think it is worth changing. I think any change or addition would make it confusing.

@oscargus
Copy link
Member

oscargus commented May 8, 2022

Thanks @23ccozad for the PR and @andrew-fennell for checking and approving.

As documentation changes can be merged with a single approval (on the "better than before" premise) and the additional approval, I'll merge.

Congratulations on your first PR to Matplotlib! Hope to see you around!

@oscargus oscargus merged commit 65e9620 into matplotlib:main May 8, 2022
@oscargus
Copy link
Member

oscargus commented May 8, 2022

@meeseeksdev backport to v3.5.x
@meeseeksdev backport to v3.5.2-doc

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.

4 participants