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

Skip to content

Backport PR #26565 on branch v3.8.x ([doc]: added section Verify installation) #26599

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.

Sign up for GitHub

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
Aug 25, 2023
Merged

Backport PR #26565 on branch v3.8.x ([doc]: added section Verify installation) #26599

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions doc/devel/development_setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,22 @@ 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
=======================

Run the following command to make sure you have correctly installed Matplotlib in editable mode.
The command should be run when the virtual environment is activated ::

python -c "import matplotlib; print(matplotlib.__file__)"

This command should return : ``<matplotlib_local_repo>\lib\matplotlib\__init__.py``

We encourage you to run tests and build docs to verify that the code installed correctly and that the docs build cleanly,
so that when you make code or document related changes you are aware of the existing issues beforehand.

* Run test cases to verify installation :ref:`testing`
* Verify documentation build :ref:`documenting-matplotlib`

Install pre-commit hooks
========================
`pre-commit <https://pre-commit.com/>`_ hooks save time in the review process by
Expand Down