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

Skip to content

Commit 91ca64c

Browse files
committed
[doc]: added section Verify installation
1 parent db533bf commit 91ca64c

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

doc/devel/development_setup.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,22 @@ true for ``*.py`` files. If you change the C-extension source (which might
164164
also happen if you change branches) you will have to re-run
165165
``python -m pip install -ve .``
166166

167+
Verify the Installation
168+
=======================
169+
170+
1. Run the following command to make sure you have correctly installed matplotlib in editable mode.
171+
The command should be run when the virtual environment is activated ::
172+
173+
python -c "import matplotlib; print(matplotlib.__file__)"
174+
175+
This command should return : ``<matplotlib_local_repo>\lib\matplotlib\__init__.py``
176+
177+
2. We encourage you to run tests and build docs to verify that the code installed correctly and that the docs build are clean,
178+
so that when you make code or document related changes you are aware of the existing issues beforehand.
179+
180+
* Run test cases to verify installation :ref:`testing`
181+
* Verify documentation build :ref:`documenting-matplotlib`
182+
167183
Install pre-commit hooks (optional)
168184
===================================
169185
`pre-commit <https://pre-commit.com/>`_ hooks automatically check flake8 and

0 commit comments

Comments
 (0)