Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

[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

Closed
wants to merge 33 commits into from
Closed
Changes from 7 commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
5d6a940
[doc]: add 'validate' section to install doc
devilsaint99 Jul 30, 2023
46b9071
[doc]: add 'validate' section to install doc
devilsaint99 Jul 30, 2023
efc914a
[doc]: add 'validate' section to install doc
devilsaint99 Jul 30, 2023
8bbb2a1
[doc]: add 'validate' section to install doc
devilsaint99 Jul 30, 2023
d35617b
[doc]: add 'validate' section to install doc
devilsaint99 Jul 30, 2023
15a2df1
[doc]: add 'validate' section to install doc
devilsaint99 Jul 30, 2023
0d77a8a
[doc]: add 'validate' section to install doc
devilsaint99 Jul 30, 2023
2f7fc9c
Merge remote-tracking branch 'upstream/main' into doc-install-check
devilsaint99 Aug 2, 2023
4dbae69
[doc]: add 'validate' section to install doc
devilsaint99 Aug 2, 2023
4247f53
[doc]: add 'validate' section to install doc
devilsaint99 Aug 2, 2023
646e4b1
Merge remote-tracking branch 'upstream/main' into doc-install-check
devilsaint99 Aug 4, 2023
f5c3053
Merge remote-tracking branch 'upstream/main' into doc-install-check
devilsaint99 Aug 5, 2023
17910c4
[doc]: add 'validate' section to install doc
devilsaint99 Aug 5, 2023
ac6292e
[doc]: add 'validate' section to install doc
devilsaint99 Aug 5, 2023
318d192
[doc]: add 'validate' section to install doc
devilsaint99 Aug 5, 2023
5059bd1
[doc]: add 'validate' section to install doc
devilsaint99 Aug 7, 2023
254e992
[doc]: add 'validate' section to install doc
devilsaint99 Jul 30, 2023
f919744
[doc]: add 'validate' section to install doc
devilsaint99 Jul 30, 2023
4e55f47
[doc]: add 'validate' section to install doc
devilsaint99 Jul 30, 2023
c2ae487
[doc]: add 'validate' section to install doc
devilsaint99 Jul 30, 2023
9441ef8
[doc]: add 'validate' section to install doc
devilsaint99 Jul 30, 2023
8a40776
[doc]: add 'validate' section to install doc
devilsaint99 Jul 30, 2023
988b7f3
[doc]: add 'validate' section to install doc
devilsaint99 Jul 30, 2023
a988c2a
[doc]: add 'validate' section to install doc
devilsaint99 Aug 2, 2023
f685c3d
[doc]: add 'validate' section to install doc
devilsaint99 Aug 2, 2023
b328f77
[doc]: add 'validate' section to install doc
devilsaint99 Aug 5, 2023
a368c86
[doc]: add 'validate' section to install doc
devilsaint99 Aug 5, 2023
bae1ea6
[doc]: add 'validate' section to install doc
devilsaint99 Aug 5, 2023
a6bf266
[doc]: add 'validate' section to install doc
devilsaint99 Aug 7, 2023
5de29bf
Merge remote branch 'doc-install-check'
devilsaint99 Aug 12, 2023
969109f
[doc]: add 'validate' section to install doc
devilsaint99 Jul 30, 2023
44c1c47
[doc]: add 'validate' section to install doc
devilsaint99 Aug 21, 2023
a22331c
Merge branch 'doc-install-check' of https://github.com/devilsaint99/m…
devilsaint99 Aug 21, 2023
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
13 changes: 13 additions & 0 deletions 13 doc/devel/development_setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
==============================
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Verify the Installation
==============================
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.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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.
1. Run the following command to make sure you have correctly installed matplotlib in editable mode. The command should be run in the development virtual environment when the environment is active.

Copy link
Member

Choose a reason for hiding this comment

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

This needs to be changed because a) the development is incomplete - development what? b) subjects activate, objects are activated- since the environment can't activate itself, it is activated

::
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`
Copy link
Member

Choose a reason for hiding this comment

The 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
Expand Down
Morty Proxy This is a proxified and sanitized view of the page, visit original site.