Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Move doc/users/installing/ to doc/install/ #27747

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

Merged
merged 9 commits into from
Apr 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion INSTALL.rst
Original file line number Diff line number Diff line change
@@ -1 +1 @@
See doc/users/installing/index.rst
See doc/install/index.rst
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ and various graphical user interface toolkits.

See the [install
documentation](https://matplotlib.org/stable/users/installing/index.html),
which is generated from `/doc/users/installing/index.rst`
which is generated from `/doc/install/index.rst`

## Contribute

Expand Down
2 changes: 1 addition & 1 deletion doc/api/prev_api_changes/api_changes_3.1.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion doc/devel/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
2 changes: 1 addition & 1 deletion doc/devel/development_setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ must be installed separately.
.. toctree::
:maxdepth: 2

../users/installing/dependencies
../install/dependencies


.. _development-install:
Expand Down
6 changes: 3 additions & 3 deletions doc/devel/document.rst
Original file line number Diff line number Diff line change
Expand Up @@ -239,22 +239,22 @@ Examples:

.. code-block:: rst

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`

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

Expand Down
4 changes: 2 additions & 2 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@ Install
.. toctree::
:maxdepth: 2

users/installing/index
install/index

For more detailed instructions, see the
:doc:`installation guide <users/installing/index>`.
:doc:`installation guide <install/index>`.

Learn
=====
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. redirect-from: /devel/dependencies
.. redirect-from:: /devel/dependencies
.. redirect-from:: /users/installing/dependencies

.. _dependencies:

Expand Down Expand Up @@ -391,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:


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

.. redirect-from:: /faq/installing_faq
.. redirect-from:: /users/faq/installing_faq
.. redirect-from:: /users/installing/environment_variables_faq

=====================
Environment variables
Expand Down
1 change: 1 addition & 0 deletions doc/users/installing/index.rst → doc/install/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. redirect-from:: /users/installing
.. redirect-from:: /users/installing/index

************
Installation
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
.. _troubleshooting-install:

.. redirect-from:: /users/installing/troubleshooting_faq

Troubleshooting
===============

Expand Down
2 changes: 1 addition & 1 deletion doc/users/getting_started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Installation quick-start

conda install -c conda-forge matplotlib

Further details are available in the :doc:`Installation Guide </users/installing/index>`.
Further details are available in the :doc:`Installation Guide </install/index>`.


Draw a first plot
Expand Down
2 changes: 1 addition & 1 deletion doc/users/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,4 +102,4 @@ Using Matplotlib
:hidden:

getting_started/index
installing/index
../install/index
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Copy link
Member

Choose a reason for hiding this comment

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

is it ok to change this now or should this wait for the other redirects?

Copy link
Member

Choose a reason for hiding this comment

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

I think it's fine; it'll only affect the rc page, and once final is out, we'll update the main page to go along with it.

"Documentation" = "https://matplotlib.org"
"Source Code" = "https://github.com/matplotlib/matplotlib"
"Bug Tracker" = "https://github.com/matplotlib/matplotlib/issues"
Expand Down