From 5d6a940afff10c9e32e68f6892ac443f79c69f5f Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Sun, 30 Jul 2023 15:51:03 +0530 Subject: [PATCH 01/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index 8625eaa60042..d89d985e7a19 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -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 +============================== + +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. + + python -c "import matplotlib; print(matplotlib.__file__)" + + This command should return : ``\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` + Install pre-commit hooks (optional) =================================== `pre-commit `_ hooks automatically check flake8 and From 46b907103c25f928115a6cd141bf57a141dc57d2 Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Sun, 30 Jul 2023 15:53:07 +0530 Subject: [PATCH 02/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index d89d985e7a19..5e06a52ea6da 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -169,7 +169,7 @@ 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. - python -c "import matplotlib; print(matplotlib.__file__)" + python -c "import matplotlib; print(matplotlib.__file__)" This command should return : ``\lib\matplotlib\__init__.py`` 2. Link to the running the tests page to verify that the code installed clean: From efc914af8681b12ec5e66c080c6a9ed8d1becafe Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Sun, 30 Jul 2023 15:59:11 +0530 Subject: [PATCH 03/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index 5e06a52ea6da..cc4ec17140bd 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -169,7 +169,8 @@ 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. - python -c "import matplotlib; print(matplotlib.__file__)" + .. code-block:: bash + python -c "import matplotlib; print(matplotlib.__file__)" This command should return : ``\lib\matplotlib\__init__.py`` 2. Link to the running the tests page to verify that the code installed clean: From 8bbb2a14719051c7d6a9fdd5af1a66afde80fc34 Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Sun, 30 Jul 2023 17:16:24 +0530 Subject: [PATCH 04/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index cc4ec17140bd..0093dcf1c9ff 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -169,7 +169,7 @@ 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. - .. code-block:: bash + .. code-block:: none python -c "import matplotlib; print(matplotlib.__file__)" This command should return : ``\lib\matplotlib\__init__.py`` From d35617b820181291af2afde255dde53fc18b054f Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Sun, 30 Jul 2023 17:21:48 +0530 Subject: [PATCH 05/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index 0093dcf1c9ff..590ae260404f 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -167,9 +167,8 @@ also happen if you change branches) you will have to re-run 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. - - .. code-block:: none +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.:: + python -c "import matplotlib; print(matplotlib.__file__)" This command should return : ``\lib\matplotlib\__init__.py`` From 15a2df1eec20f9f461bb6f4df63a3fe26d2c43d7 Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Sun, 30 Jul 2023 17:22:59 +0530 Subject: [PATCH 06/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index 590ae260404f..db04b5f00ddd 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -167,8 +167,8 @@ also happen if you change branches) you will have to re-run 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.:: - +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.: + python -c "import matplotlib; print(matplotlib.__file__)" This command should return : ``\lib\matplotlib\__init__.py`` From 0d77a8ad0b5e506751aca80b29f5fd2adb374247 Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Sun, 30 Jul 2023 17:23:42 +0530 Subject: [PATCH 07/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index db04b5f00ddd..a5093ee0055e 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -167,8 +167,8 @@ also happen if you change branches) you will have to re-run 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.: - +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. + :: python -c "import matplotlib; print(matplotlib.__file__)" This command should return : ``\lib\matplotlib\__init__.py`` From 4dbae69c3405b1a673a792fa066d32bdf95f7078 Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Wed, 2 Aug 2023 21:05:23 +0530 Subject: [PATCH 08/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index a5093ee0055e..763cf113a9f6 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -167,16 +167,17 @@ also happen if you change branches) you will have to re-run 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. - :: +* 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 :: + python -c "import matplotlib; print(matplotlib.__file__)" - - This command should return : ``\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` + This command should return : ``\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. + Please refer to :ref:`documenting-matplotlib` and :ref:`testing` for building docs and run test cases. + Install pre-commit hooks (optional) =================================== `pre-commit `_ hooks automatically check flake8 and From 4247f533a1b3f989c54c5e06d5d1211a5e93b135 Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Wed, 2 Aug 2023 22:07:32 +0530 Subject: [PATCH 09/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index 763cf113a9f6..310a3af09704 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -174,8 +174,8 @@ Verify the Installation This command should return : ``\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. +* We encourage you to run tests and build docs to verify that the code installed and docs build are clean, + so that when you make code or document related changes you are aware of the existing issues beforehand. Please refer to :ref:`documenting-matplotlib` and :ref:`testing` for building docs and run test cases. Install pre-commit hooks (optional) From 17910c4c15ced0bb32c330db65e361e292fefa5e Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Sat, 5 Aug 2023 14:57:51 +0530 Subject: [PATCH 10/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index 310a3af09704..176c29801f5a 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -176,7 +176,9 @@ Verify the Installation * We encourage you to run tests and build docs to verify that the code installed and docs build are clean, so that when you make code or document related changes you are aware of the existing issues beforehand. - Please refer to :ref:`documenting-matplotlib` and :ref:`testing` for building docs and run test cases. + Please refer to the following links shared to: + * Run test cases and verify installation - :ref:`testing` + * Verify documentation build - :ref:`documenting-matplotlib` Install pre-commit hooks (optional) =================================== From ac6292e2ca2bc8f85e3b95ed30303eb2cd724469 Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Sat, 5 Aug 2023 19:42:24 +0530 Subject: [PATCH 11/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index 176c29801f5a..ed8384b7a913 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -177,8 +177,8 @@ Verify the Installation * We encourage you to run tests and build docs to verify that the code installed and docs build are clean, so that when you make code or document related changes you are aware of the existing issues beforehand. Please refer to the following links shared to: - * Run test cases and verify installation - :ref:`testing` - * Verify documentation build - :ref:`documenting-matplotlib` + * Run test cases and verify installation - :ref:`testing` + * Verify documentation build - :ref:`documenting-matplotlib` Install pre-commit hooks (optional) =================================== From 318d192e60cd1a2e0f9aba804b438994e7976329 Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Sat, 5 Aug 2023 21:03:25 +0530 Subject: [PATCH 12/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index ed8384b7a913..980aaa6fbae2 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -177,8 +177,9 @@ Verify the Installation * We encourage you to run tests and build docs to verify that the code installed and docs build are clean, so that when you make code or document related changes you are aware of the existing issues beforehand. Please refer to the following links shared to: - * Run test cases and verify installation - :ref:`testing` - * Verify documentation build - :ref:`documenting-matplotlib` + + * Run test cases and verify installation :ref:`testing` + * Verify documentation build :ref:`documenting-matplotlib` Install pre-commit hooks (optional) =================================== From 5059bd192ca12bde79673fec4614f86aec98a985 Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Mon, 7 Aug 2023 16:35:22 +0530 Subject: [PATCH 13/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index 980aaa6fbae2..d8e8df8ebd33 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -174,11 +174,10 @@ Verify the Installation This command should return : ``\lib\matplotlib\__init__.py`` -* We encourage you to run tests and build docs to verify that the code installed and docs build are clean, +* We encourage you to run tests and build docs to verify that the code installed correctly and that the docs build are clean, so that when you make code or document related changes you are aware of the existing issues beforehand. - Please refer to the following links shared to: - * Run test cases and verify installation :ref:`testing` + * Run test cases to verify installation :ref:`testing` * Verify documentation build :ref:`documenting-matplotlib` Install pre-commit hooks (optional) From 254e992ad0de82fb21ef662d045075de8b80b269 Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Sun, 30 Jul 2023 15:51:03 +0530 Subject: [PATCH 14/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index 8625eaa60042..d89d985e7a19 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -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 +============================== + +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. + + python -c "import matplotlib; print(matplotlib.__file__)" + + This command should return : ``\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` + Install pre-commit hooks (optional) =================================== `pre-commit `_ hooks automatically check flake8 and From f9197445758adfa7c03ae84becc29bf13ea46b2c Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Sun, 30 Jul 2023 15:53:07 +0530 Subject: [PATCH 15/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index d89d985e7a19..5e06a52ea6da 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -169,7 +169,7 @@ 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. - python -c "import matplotlib; print(matplotlib.__file__)" + python -c "import matplotlib; print(matplotlib.__file__)" This command should return : ``\lib\matplotlib\__init__.py`` 2. Link to the running the tests page to verify that the code installed clean: From 4e55f473b195b7384f13883f8e6ca26a0409d029 Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Sun, 30 Jul 2023 15:59:11 +0530 Subject: [PATCH 16/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index 5e06a52ea6da..cc4ec17140bd 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -169,7 +169,8 @@ 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. - python -c "import matplotlib; print(matplotlib.__file__)" + .. code-block:: bash + python -c "import matplotlib; print(matplotlib.__file__)" This command should return : ``\lib\matplotlib\__init__.py`` 2. Link to the running the tests page to verify that the code installed clean: From c2ae48758052ca697a8f4b9972d10425df459171 Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Sun, 30 Jul 2023 17:16:24 +0530 Subject: [PATCH 17/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index cc4ec17140bd..0093dcf1c9ff 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -169,7 +169,7 @@ 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. - .. code-block:: bash + .. code-block:: none python -c "import matplotlib; print(matplotlib.__file__)" This command should return : ``\lib\matplotlib\__init__.py`` From 9441ef816abb13c7d622df4dfe8d526f06e31f02 Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Sun, 30 Jul 2023 17:21:48 +0530 Subject: [PATCH 18/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index 0093dcf1c9ff..590ae260404f 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -167,9 +167,8 @@ also happen if you change branches) you will have to re-run 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. - - .. code-block:: none +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.:: + python -c "import matplotlib; print(matplotlib.__file__)" This command should return : ``\lib\matplotlib\__init__.py`` From 8a407765f699ac4c8eaefa0a317bc28f22921ab8 Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Sun, 30 Jul 2023 17:22:59 +0530 Subject: [PATCH 19/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index 590ae260404f..db04b5f00ddd 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -167,8 +167,8 @@ also happen if you change branches) you will have to re-run 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.:: - +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.: + python -c "import matplotlib; print(matplotlib.__file__)" This command should return : ``\lib\matplotlib\__init__.py`` From 988b7f3075d7e7a76e9e906b16cd6ab9c65b8496 Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Sun, 30 Jul 2023 17:23:42 +0530 Subject: [PATCH 20/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index db04b5f00ddd..a5093ee0055e 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -167,8 +167,8 @@ also happen if you change branches) you will have to re-run 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.: - +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. + :: python -c "import matplotlib; print(matplotlib.__file__)" This command should return : ``\lib\matplotlib\__init__.py`` From a988c2a1feb993f9b0ab2af16e5ace8e8776cf91 Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Wed, 2 Aug 2023 21:05:23 +0530 Subject: [PATCH 21/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index a5093ee0055e..763cf113a9f6 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -167,16 +167,17 @@ also happen if you change branches) you will have to re-run 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. - :: +* 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 :: + python -c "import matplotlib; print(matplotlib.__file__)" - - This command should return : ``\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` + This command should return : ``\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. + Please refer to :ref:`documenting-matplotlib` and :ref:`testing` for building docs and run test cases. + Install pre-commit hooks (optional) =================================== `pre-commit `_ hooks automatically check flake8 and From f685c3d362024b25c67271d24680e00404cb1e50 Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Wed, 2 Aug 2023 22:07:32 +0530 Subject: [PATCH 22/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index 763cf113a9f6..310a3af09704 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -174,8 +174,8 @@ Verify the Installation This command should return : ``\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. +* We encourage you to run tests and build docs to verify that the code installed and docs build are clean, + so that when you make code or document related changes you are aware of the existing issues beforehand. Please refer to :ref:`documenting-matplotlib` and :ref:`testing` for building docs and run test cases. Install pre-commit hooks (optional) From b328f7741adc7859617bbfe1dead6c944e7d4c5f Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Sat, 5 Aug 2023 14:57:51 +0530 Subject: [PATCH 23/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index 310a3af09704..176c29801f5a 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -176,7 +176,9 @@ Verify the Installation * We encourage you to run tests and build docs to verify that the code installed and docs build are clean, so that when you make code or document related changes you are aware of the existing issues beforehand. - Please refer to :ref:`documenting-matplotlib` and :ref:`testing` for building docs and run test cases. + Please refer to the following links shared to: + * Run test cases and verify installation - :ref:`testing` + * Verify documentation build - :ref:`documenting-matplotlib` Install pre-commit hooks (optional) =================================== From a368c86349e1398c23a7ec6e92a6c27396a58af3 Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Sat, 5 Aug 2023 19:42:24 +0530 Subject: [PATCH 24/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index 176c29801f5a..ed8384b7a913 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -177,8 +177,8 @@ Verify the Installation * We encourage you to run tests and build docs to verify that the code installed and docs build are clean, so that when you make code or document related changes you are aware of the existing issues beforehand. Please refer to the following links shared to: - * Run test cases and verify installation - :ref:`testing` - * Verify documentation build - :ref:`documenting-matplotlib` + * Run test cases and verify installation - :ref:`testing` + * Verify documentation build - :ref:`documenting-matplotlib` Install pre-commit hooks (optional) =================================== From bae1ea640a5edf0cad863dd85d72becd2f188f66 Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Sat, 5 Aug 2023 21:03:25 +0530 Subject: [PATCH 25/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index ed8384b7a913..980aaa6fbae2 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -177,8 +177,9 @@ Verify the Installation * We encourage you to run tests and build docs to verify that the code installed and docs build are clean, so that when you make code or document related changes you are aware of the existing issues beforehand. Please refer to the following links shared to: - * Run test cases and verify installation - :ref:`testing` - * Verify documentation build - :ref:`documenting-matplotlib` + + * Run test cases and verify installation :ref:`testing` + * Verify documentation build :ref:`documenting-matplotlib` Install pre-commit hooks (optional) =================================== From a6bf2669adf204913e285bc4be3e1433184d0f33 Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Mon, 7 Aug 2023 16:35:22 +0530 Subject: [PATCH 26/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index 980aaa6fbae2..d8e8df8ebd33 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -174,11 +174,10 @@ Verify the Installation This command should return : ``\lib\matplotlib\__init__.py`` -* We encourage you to run tests and build docs to verify that the code installed and docs build are clean, +* We encourage you to run tests and build docs to verify that the code installed correctly and that the docs build are clean, so that when you make code or document related changes you are aware of the existing issues beforehand. - Please refer to the following links shared to: - * Run test cases and verify installation :ref:`testing` + * Run test cases to verify installation :ref:`testing` * Verify documentation build :ref:`documenting-matplotlib` Install pre-commit hooks (optional) From 969109f6c201e2ef5678ceeb4449c44c95e273d6 Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Sun, 30 Jul 2023 15:51:03 +0530 Subject: [PATCH 27/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index 8625eaa60042..a329d24a65a8 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -164,6 +164,24 @@ 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 activated :: + + python -c "import matplotlib; print(matplotlib.__file__)" + +This command should return : ``\lib\matplotlib\__init__.py`` + +We encourage you to run tests and build docs to verify that the code installed +correctly and that the docs build are clean, so that when you make code or +document related changes you are aware of the existing issues beforehand. + +* Run test cases to verify installation :ref:`testing` +* Verify documentation build :ref:`documenting-matplotlib` + Install pre-commit hooks (optional) =================================== `pre-commit `_ hooks automatically check flake8 and From 44c1c475300bba1937d8c75331aeb2aa577dc847 Mon Sep 17 00:00:00 2001 From: Devilsaint Date: Mon, 21 Aug 2023 20:46:48 +0530 Subject: [PATCH 28/28] [doc]: add 'validate' section to install doc --- doc/devel/development_setup.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index d8e8df8ebd33..da1b7e22e8c2 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -165,10 +165,10 @@ 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 :: + The command should be run when the virtual environment is activated :: python -c "import matplotlib; print(matplotlib.__file__)"