Repository navigation
[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
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 46b9071
[doc]: add 'validate' section to install doc
devilsaint99 efc914a
[doc]: add 'validate' section to install doc
devilsaint99 8bbb2a1
[doc]: add 'validate' section to install doc
devilsaint99 d35617b
[doc]: add 'validate' section to install doc
devilsaint99 15a2df1
[doc]: add 'validate' section to install doc
devilsaint99 0d77a8a
[doc]: add 'validate' section to install doc
devilsaint99 2f7fc9c
Merge remote-tracking branch 'upstream/main' into doc-install-check
devilsaint99 4dbae69
[doc]: add 'validate' section to install doc
devilsaint99 4247f53
[doc]: add 'validate' section to install doc
devilsaint99 646e4b1
Merge remote-tracking branch 'upstream/main' into doc-install-check
devilsaint99 f5c3053
Merge remote-tracking branch 'upstream/main' into doc-install-check
devilsaint99 17910c4
[doc]: add 'validate' section to install doc
devilsaint99 ac6292e
[doc]: add 'validate' section to install doc
devilsaint99 318d192
[doc]: add 'validate' section to install doc
devilsaint99 5059bd1
[doc]: add 'validate' section to install doc
devilsaint99 254e992
[doc]: add 'validate' section to install doc
devilsaint99 f919744
[doc]: add 'validate' section to install doc
devilsaint99 4e55f47
[doc]: add 'validate' section to install doc
devilsaint99 c2ae487
[doc]: add 'validate' section to install doc
devilsaint99 9441ef8
[doc]: add 'validate' section to install doc
devilsaint99 8a40776
[doc]: add 'validate' section to install doc
devilsaint99 988b7f3
[doc]: add 'validate' section to install doc
devilsaint99 a988c2a
[doc]: add 'validate' section to install doc
devilsaint99 f685c3d
[doc]: add 'validate' section to install doc
devilsaint99 b328f77
[doc]: add 'validate' section to install doc
devilsaint99 a368c86
[doc]: add 'validate' section to install doc
devilsaint99 bae1ea6
[doc]: add 'validate' section to install doc
devilsaint99 a6bf266
[doc]: add 'validate' section to install doc
devilsaint99 5de29bf
Merge remote branch 'doc-install-check'
devilsaint99 969109f
[doc]: add 'validate' section to install doc
devilsaint99 44c1c47
[doc]: add 'validate' section to install doc
devilsaint99 a22331c
Merge branch 'doc-install-check' of https://github.com/devilsaint99/m…
devilsaint99 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
|
|
@@ -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 | ||||||||
| ============================== | ||||||||
|
|
||||||||
| * 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 :: | ||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||
|
|
||||||||
| 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. | ||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Way better! Small suggestion to tighten the wording:
Suggested change
And then I suggest a small bulleted list kinda like:
|
||||||||
| Please refer to :ref:`documenting-matplotlib` and :ref:`testing` for building docs and run test cases. | ||||||||
|
story645 marked this conversation as resolved.
Outdated
|
||||||||
|
|
||||||||
| Install pre-commit hooks (optional) | ||||||||
| =================================== | ||||||||
| `pre-commit <https://pre-commit.com/>`_ hooks automatically check flake8 and | ||||||||
|
|
||||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.