8000 [doc]: add 'validate' section to install doc · matplotlib/matplotlib@254e992 · GitHub
[go: up one dir, main page]

Skip to content

Commit 254e992

Browse files
committed
[doc]: add 'validate' section to install doc
1 parent 5d5700a commit 254e992

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

doc/devel/development_setup.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,19 @@ 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. The command should be run when virtual environment is activate.
171+
172+
python -c "import matplotlib; print(matplotlib.__file__)"
173+
174+
This command should return : ``<matplotlib_local_repo>\lib\matplotlib\__init__.py``
175+
2. Link to the running the tests page to verify that the code installed clean:
176+
:ref:`testing`
177+
3. Link to the building the docs page to verify that the docs build clean:
178+
:ref:`documenting-matplotlib`
179+
167180
Install pre-commit hooks (optional)
168181
===================================
169182
`pre-commit <https://pre-commit.com/>`_ hooks automatically check flake8 and

0 commit comments

Comments
 (0)
0