Skip to content
Closed
Changes from 9 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
14 changes: 14 additions & 0 deletions doc/devel/development_setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,20 @@ 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
Copy Markdown
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
=======================


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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
The command should be run in the development when the virtual environment is activate ::
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 would encourage you to run tests and build docs to verify that the code installed and docs build are clean respectively,
These two are recommended, so that when you make code or document related changes you are aware of the existing issues beforehand.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Way better! Small suggestion to tighten the wording:

Suggested change
* We would encourage you to run tests and build docs to verify that the code installed and docs build are clean respectively,
These two are recommended, so that when you make code or document related changes you are aware of the existing issues beforehand.
* We encourage you to run tests and build docs to verify that the code install and docs build are clean, , so that when you make code or document related changes you are aware of the existing issues.

And then I suggest a small bulleted list kinda like:
`

  • verify install : :ref:testing
  • verify documentation build: :ref:documenting-matplotlib
    `
    so that someone who is skimming can quickly find the link.

Please refer to :ref:`documenting-matplotlib` and :ref:`testing` for building docs and run test cases.
Comment thread
story645 marked this conversation as resolved.
Outdated

Install pre-commit hooks (optional)
===================================
`pre-commit <https://pre-commit.com/>`_ hooks automatically check flake8 and
Expand Down