From 0ca3e594939916ee8c2f749c9b3e085cd13ef6b8 Mon Sep 17 00:00:00 2001 From: shriyakalakata Date: Sun, 4 Feb 2024 20:18:28 -0500 Subject: [PATCH 1/9] Move doc/users/installing/ to doc/install/ --- doc/{users/installing => install}/dependencies.rst | 0 doc/{users/installing => install}/environment_variables_faq.rst | 0 doc/{users/installing => install}/index.rst | 0 doc/{users/installing => install}/troubleshooting_faq.inc.rst | 0 4 files changed, 0 insertions(+), 0 deletions(-) rename doc/{users/installing => install}/dependencies.rst (100%) rename doc/{users/installing => install}/environment_variables_faq.rst (100%) rename doc/{users/installing => install}/index.rst (100%) rename doc/{users/installing => install}/troubleshooting_faq.inc.rst (100%) diff --git a/doc/users/installing/dependencies.rst b/doc/install/dependencies.rst similarity index 100% rename from doc/users/installing/dependencies.rst rename to doc/install/dependencies.rst diff --git a/doc/users/installing/environment_variables_faq.rst b/doc/install/environment_variables_faq.rst similarity index 100% rename from doc/users/installing/environment_variables_faq.rst rename to doc/install/environment_variables_faq.rst diff --git a/doc/users/installing/index.rst b/doc/install/index.rst similarity index 100% rename from doc/users/installing/index.rst rename to doc/install/index.rst diff --git a/doc/users/installing/troubleshooting_faq.inc.rst b/doc/install/troubleshooting_faq.inc.rst similarity index 100% rename from doc/users/installing/troubleshooting_faq.inc.rst rename to doc/install/troubleshooting_faq.inc.rst From 5570d235ecea67b1122a86336e02c23c672e5644 Mon Sep 17 00:00:00 2001 From: shriyakalakata Date: Sun, 4 Feb 2024 20:33:16 -0500 Subject: [PATCH 2/9] Add redirects --- doc/install/environment_variables_faq.rst | 1 + doc/install/index.rst | 1 + doc/install/troubleshooting_faq.inc.rst | 2 ++ 3 files changed, 4 insertions(+) diff --git a/doc/install/environment_variables_faq.rst b/doc/install/environment_variables_faq.rst index efbcd9980fd0..ba384343cc5a 100644 --- a/doc/install/environment_variables_faq.rst +++ b/doc/install/environment_variables_faq.rst @@ -3,6 +3,7 @@ .. redirect-from:: /faq/installing_faq .. redirect-from:: /users/faq/installing_faq +.. redirect-from:: /users/installing/environment_variables_faq ===================== Environment variables diff --git a/doc/install/index.rst b/doc/install/index.rst index fa5187081b2f..ea8e29d71565 100644 --- a/doc/install/index.rst +++ b/doc/install/index.rst @@ -1,4 +1,5 @@ .. redirect-from:: /users/installing +.. redirect-from:: /users/installing/index ************ Installation diff --git a/doc/install/troubleshooting_faq.inc.rst b/doc/install/troubleshooting_faq.inc.rst index 2314187a9542..d130813a80c6 100644 --- a/doc/install/troubleshooting_faq.inc.rst +++ b/doc/install/troubleshooting_faq.inc.rst @@ -1,5 +1,7 @@ .. _troubleshooting-install: +.. redirect-from:: /users/installing/troubleshooting_faq + Troubleshooting =============== From 41964fe88bf0c35c2d586a3bb6e1ca98c3a1ad77 Mon Sep 17 00:00:00 2001 From: shriyakalakata Date: Wed, 13 Mar 2024 18:09:25 -0400 Subject: [PATCH 3/9] Add redirect for dependencies.rst --- doc/install/dependencies.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/install/dependencies.rst b/doc/install/dependencies.rst index fa666d280732..34eda8112cb8 100644 --- a/doc/install/dependencies.rst +++ b/doc/install/dependencies.rst @@ -1,4 +1,5 @@ .. redirect-from: /devel/dependencies +.. redirect-from:: /users/installing/dependencies.rst .. _dependencies: From 43c70c8b87d0843dbb3f186336269431e886d581 Mon Sep 17 00:00:00 2001 From: shriyakalakata Date: Wed, 13 Mar 2024 18:14:36 -0400 Subject: [PATCH 4/9] Update relative path for doc-requirements.txt --- doc/install/dependencies.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/install/dependencies.rst b/doc/install/dependencies.rst index 34eda8112cb8..4a5d8c8dd4c4 100644 --- a/doc/install/dependencies.rst +++ b/doc/install/dependencies.rst @@ -392,7 +392,7 @@ The additional Python packages required to build the The content of :file:`doc-requirements.txt` is also shown below: -.. include:: ../../../requirements/doc/doc-requirements.txt +.. include:: ../../requirements/doc/doc-requirements.txt :literal: From 892a573ca6b2286abe6b5e0c0871bc49a4997474 Mon Sep 17 00:00:00 2001 From: shriyakalakata Date: Wed, 13 Mar 2024 18:28:58 -0400 Subject: [PATCH 5/9] Change to --- INSTALL.rst | 2 +- README.md | 4 ++-- doc/api/prev_api_changes/api_changes_3.1.0.rst | 2 +- doc/devel/contribute.rst | 2 +- doc/devel/development_setup.rst | 2 +- doc/devel/document.rst | 6 +++--- doc/index.rst | 4 ++-- doc/users/getting_started/index.rst | 2 +- pyproject.toml | 2 +- 9 files changed, 13 insertions(+), 13 deletions(-) diff --git a/INSTALL.rst b/INSTALL.rst index ac24c70ac518..3fb01c58d259 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -1 +1 @@ -See doc/users/installing/index.rst +See doc/install/index.rst diff --git a/README.md b/README.md index 6751e9a56e35..78d4862800e5 100644 --- a/README.md +++ b/README.md @@ -31,8 +31,8 @@ and various graphical user interface toolkits. ## Install See the [install -documentation](https://matplotlib.org/stable/users/installing/index.html), -which is generated from `/doc/users/installing/index.rst` +documentation](https://matplotlib.org/stable/install/index.html), +which is generated from `/doc/install/index.rst` ## Contribute diff --git a/doc/api/prev_api_changes/api_changes_3.1.0.rst b/doc/api/prev_api_changes/api_changes_3.1.0.rst index 18f25d459200..5b06af781938 100644 --- a/doc/api/prev_api_changes/api_changes_3.1.0.rst +++ b/doc/api/prev_api_changes/api_changes_3.1.0.rst @@ -308,7 +308,7 @@ FreeType or libpng are not in the compiler or linker's default path, set the standard environment variables ``CFLAGS``/``LDFLAGS`` on Linux or OSX, or ``CL``/``LINK`` on Windows, to indicate the relevant paths. -See details in :doc:`/users/installing/index`. +See details in :doc:`/install/index`. Setting artist properties twice or more in the same call ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/devel/contribute.rst b/doc/devel/contribute.rst index 510b67eead91..8c297beaddc1 100644 --- a/doc/devel/contribute.rst +++ b/doc/devel/contribute.rst @@ -266,7 +266,7 @@ document's URL roughly corresponds to its location in our folder structure: .. grid-item:: information about the library - * :file:`doc/users/installing/` + * :file:`doc/install/` * :file:`doc/project/` * :file:`doc/users/resources/` * :file:`doc/users/faq.rst` diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index 5b68172c2fc9..be99bed2fe5f 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -165,7 +165,7 @@ must be installed separately. .. toctree:: :maxdepth: 2 - ../users/installing/dependencies + ../install/dependencies .. _development-install: diff --git a/doc/devel/document.rst b/doc/devel/document.rst index d354ee5f238b..620c12c8db1c 100644 --- a/doc/devel/document.rst +++ b/doc/devel/document.rst @@ -239,7 +239,7 @@ Examples: .. code-block:: rst - See the :doc:`/users/installing/index` + See the :doc:`/install/index` See the tutorial :ref:`quick_start` @@ -247,14 +247,14 @@ Examples: will render as: - See the :doc:`/users/installing/index` + See the :doc:`/install/index` See the tutorial :ref:`quick_start` See the example :doc:`/gallery/lines_bars_and_markers/simple_plot` Sections can also be given reference labels. For instance from the -:doc:`/users/installing/index` link: +:doc:`/install/index` link: .. code-block:: rst diff --git a/doc/index.rst b/doc/index.rst index 00814b5ccc71..1a385d2330af 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -34,10 +34,10 @@ Install .. toctree:: :maxdepth: 2 - users/installing/index + install/index For more detailed instructions, see the -:doc:`installation guide `. +:doc:`installation guide `. Learn ===== diff --git a/doc/users/getting_started/index.rst b/doc/users/getting_started/index.rst index 68d62232ddc9..ac896687979d 100644 --- a/doc/users/getting_started/index.rst +++ b/doc/users/getting_started/index.rst @@ -22,7 +22,7 @@ Installation quick-start conda install -c conda-forge matplotlib -Further details are available in the :doc:`Installation Guide `. +Further details are available in the :doc:`Installation Guide `. Draw a first plot diff --git a/pyproject.toml b/pyproject.toml index 8d3ff39fc38e..0f21ac360e13 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -61,7 +61,7 @@ dev = [ [project.urls] "Homepage" = "https://matplotlib.org" -"Download" = "https://matplotlib.org/stable/users/installing/index.html" +"Download" = "https://matplotlib.org/stable/install/index.html" "Documentation" = "https://matplotlib.org" "Source Code" = "https://github.com/matplotlib/matplotlib" "Bug Tracker" = "https://github.com/matplotlib/matplotlib/issues" From 34b53336db303a391229552320df461629334227 Mon Sep 17 00:00:00 2001 From: shriyakalakata Date: Wed, 13 Mar 2024 18:32:04 -0400 Subject: [PATCH 6/9] Retain link in README to stable version --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 78d4862800e5..7b9c99597c0d 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ and various graphical user interface toolkits. ## Install See the [install -documentation](https://matplotlib.org/stable/install/index.html), +documentation](https://matplotlib.org/stable/users/installing/index.html), which is generated from `/doc/install/index.rst` ## Contribute From 064acbbdf78f114a442294136d2e8f54f5ed1775 Mon Sep 17 00:00:00 2001 From: shriyakalakata Date: Thu, 14 Mar 2024 00:32:59 -0400 Subject: [PATCH 7/9] Empty commit to trigger tests From 61a85555813f499ff8b2e744b787ee9eeff947ed Mon Sep 17 00:00:00 2001 From: shriyakalakata Date: Thu, 14 Mar 2024 01:25:17 -0400 Subject: [PATCH 8/9] Update file path in users/index.rst --- doc/users/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/users/index.rst b/doc/users/index.rst index eacb72749f81..2991e7d2b324 100644 --- a/doc/users/index.rst +++ b/doc/users/index.rst @@ -102,4 +102,4 @@ Using Matplotlib :hidden: getting_started/index - installing/index + ../install/index From aa9e209eb278691d73b929a3386a35134f333823 Mon Sep 17 00:00:00 2001 From: shriyakalakata <87483933+shriyakalakata@users.noreply.github.com> Date: Thu, 4 Apr 2024 15:49:11 -0400 Subject: [PATCH 9/9] Update doc/install/dependencies.rst Co-authored-by: Elliott Sales de Andrade --- doc/install/dependencies.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/install/dependencies.rst b/doc/install/dependencies.rst index 4a5d8c8dd4c4..45dc249832ca 100644 --- a/doc/install/dependencies.rst +++ b/doc/install/dependencies.rst @@ -1,5 +1,5 @@ -.. redirect-from: /devel/dependencies -.. redirect-from:: /users/installing/dependencies.rst +.. redirect-from:: /devel/dependencies +.. redirect-from:: /users/installing/dependencies .. _dependencies: