-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
[doc]: add 'validate' section to install docs #26379 #26416
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
Changes from 7 commits
5d6a940
46b9071
efc914a
8bbb2a1
d35617b
15a2df1
0d77a8a
2f7fc9c
4dbae69
4247f53
646e4b1
f5c3053
17910c4
ac6292e
318d192
5059bd1
254e992
f919744
4e55f47
c2ae487
9441ef8
8a40776
988b7f3
a988c2a
f685c3d
b328f77
a368c86
bae1ea6
a6bf266
5de29bf
969109f
44c1c47
a22331c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||
---|---|---|---|---|
|
@@ -164,6 +164,19 @@ true for ``*.py`` files. If you change the C-extension source (which might | |||
also happen if you change branches) you will have to re-run | ||||
``python -m pip install -ve .`` | ||||
|
||||
Verify the Installation | ||||
============================== | ||||
|
||||
1. Run the following command to make sure you have correctly installed matplotlib in editable mode. The command should be run when virtual environment is activate. | ||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This needs to be changed because a) |
||||
:: | ||||
python -c "import matplotlib; print(matplotlib.__file__)" | ||||
|
||||
This command should return : ``<matplotlib_local_repo>\lib\matplotlib\__init__.py`` | ||||
2. Link to the running the tests page to verify that the code installed clean: | ||||
:ref:`testing` | ||||
3. Link to the building the docs page to verify that the docs build clean: | ||||
:ref:`documenting-matplotlib` | ||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. While these were the instructions for writing this page, folks validating their install do not need to link to these pages. Please rewrite this to be instructive to the audience reading it. |
||||
|
||||
Install pre-commit hooks (optional) | ||||
=================================== | ||||
`pre-commit <https://pre-commit.com/>`_ hooks automatically check flake8 and | ||||
|
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.