Merge pull request matplotlib#27560 from shriyakalakata/user_guide_docs

Moved /users/project to /doc/project

Author: QuLogic

.pre-commit-config.yaml

@@ -58,7 +58,7 @@ repos:
           "--ignore-words",
           "ci/codespell-ignore-words.txt",
           "--skip",
-          "doc/users/project/credits.rst"
+          "doc/project/credits.rst"
           ]
   - repo: https://github.com/pycqa/isort
     rev: 5.13.2

CODE_OF_CONDUCT.md

@@ -1,6 +1,6 @@
 <!--placeholder page so Github knows we have a CoC-->
 
 Our Code of Conduct is at
-https://matplotlib.org/stable/users/project/code_of_conduct.html
+https://matplotlib.org/stable/project/code_of_conduct.html
 
-It is rendered from `doc/users/project/code_of_conduct.rst`
+It is rendered from `doc/project/code_of_conduct.rst`

README.md

@@ -69,5 +69,5 @@ If Matplotlib contributes to a project that leads to publication, please
 acknowledge this by citing Matplotlib.
 
 [A ready-made citation
-entry](https://matplotlib.org/stable/users/project/citing.html) is
+entry](https://matplotlib.org/stable/project/citing.html) is
 available.

doc/devel/contribute.rst

@@ -267,7 +267,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/users/project/`
+      * :file:`doc/project/`
       * :file:`doc/users/resources/`
       * :file:`doc/users/faq.rst`
       * :file:`doc/devel/`
@@ -304,7 +304,7 @@ Matplotlib's community is built by its members, if you would like to help out
 see our :ref:`communications-guidelines`.
 
 If Matplotlib contributes to a project that leads to a scientific publication,
-please follow the :doc:`/users/project/citing` guidelines.
+please follow the :doc:`/project/citing` guidelines.
 
 If you have developed an extension to Matplotlib, please consider adding it to our
 `third party package <https://github.com/matplotlib/mpl-third-party>`_  list.

doc/devel/release_guide.rst

@@ -315,8 +315,8 @@ automatically produce one once the tag is pushed). Add the DOI post-fix and vers
 the dictionary in :file:`tools/cache_zenodo_svg.py` and run the script.
 
 This will download the new SVG to :file:`doc/_static/zenodo_cache/{postfix}.svg` and
-edit :file:`doc/users/project/citing.rst`. Commit the new SVG, the change to
-:file:`tools/cache_zenodo_svg.py`, and the changes to :file:`doc/users/project/citing.rst`
+edit :file:`doc/project/citing.rst`. Commit the new SVG, the change to
+:file:`tools/cache_zenodo_svg.py`, and the changes to :file:`doc/project/citing.rst`
 to the VER-doc branch and push to GitHub. ::
 
   git checkout v3.7.0-doc

doc/index.rst

@@ -172,4 +172,4 @@ About us
         .. toctree::
             :maxdepth: 2
 
-            users/project/index.rst
+            project/index.rst

doc/users/project/citing.rst doc/project/citing.rstdoc/users/project/citing.rst renamed to doc/project/citing.rst

@@ -1,4 +1,5 @@
 .. redirect-from:: /citing
+.. redirect-from:: /users/project/citing
 
 Citing Matplotlib
 =================
@@ -8,12 +9,12 @@ please acknowledge this fact by citing `J. D. Hunter, "Matplotlib: A 2D
 Graphics Environment", Computing in Science & Engineering, vol. 9, no. 3,
 pp. 90-95, 2007 <https://doi.org/10.1109/MCSE.2007.55>`_.
 
-.. literalinclude:: ../../../CITATION.bib
+.. literalinclude:: ../../CITATION.bib
    :language: bibtex
 
 .. container:: sphx-glr-download
 
-   :download:`Download BibTeX bibliography file: CITATION.bib <../../../CITATION.bib>`
+   :download:`Download BibTeX bibliography file: CITATION.bib <../../CITATION.bib>`
 
 DOIs
 ----
@@ -30,166 +31,166 @@ By version
 
 
 v3.8.1
-   .. image:: ../../_static/zenodo_cache/10059757.svg
+   .. image:: ../_static/zenodo_cache/10059757.svg
       :target:  https://doi.org/10.5281/zenodo.10059757
 v3.8.0
-   .. image:: ../../_static/zenodo_cache/8347255.svg
+   .. image:: ../_static/zenodo_cache/8347255.svg
       :target:  https://doi.org/10.5281/zenodo.8347255
 v3.7.3
-   .. image:: ../../_static/zenodo_cache/8336761.svg
+   .. image:: ../_static/zenodo_cache/8336761.svg
       :target:  https://doi.org/10.5281/zenodo.8336761
 v3.7.2
-   .. image:: ../../_static/zenodo_cache/8118151.svg
+   .. image:: ../_static/zenodo_cache/8118151.svg
       :target:  https://doi.org/10.5281/zenodo.8118151
 v3.7.1
-   .. image:: ../../_static/zenodo_cache/7697899.svg
+   .. image:: ../_static/zenodo_cache/7697899.svg
       :target:  https://doi.org/10.5281/zenodo.7697899
 v3.7.0
-   .. image:: ../../_static/zenodo_cache/7637593.svg
+   .. image:: ../_static/zenodo_cache/7637593.svg
       :target:  https://doi.org/10.5281/zenodo.7637593
 v3.6.3
-   .. image:: ../../_static/zenodo_cache/7527665.svg
+   .. image:: ../_static/zenodo_cache/7527665.svg
       :target:  https://doi.org/10.5281/zenodo.7527665
 v3.6.2
-   .. image:: ../../_static/zenodo_cache/7275322.svg
+   .. image:: ../_static/zenodo_cache/7275322.svg
       :target:  https://doi.org/10.5281/zenodo.7275322
 v3.6.1
-   .. image:: ../../_static/zenodo_cache/7162185.svg
+   .. image:: ../_static/zenodo_cache/7162185.svg
       :target:  https://doi.org/10.5281/zenodo.7162185
 v3.6.0
-   .. image:: ../../_static/zenodo_cache/7084615.svg
+   .. image:: ../_static/zenodo_cache/7084615.svg
       :target:  https://doi.org/10.5281/zenodo.7084615
 v3.5.3
-   .. image:: ../../_static/zenodo_cache/6982547.svg
+   .. image:: ../_static/zenodo_cache/6982547.svg
       :target:  https://doi.org/10.5281/zenodo.6982547
 v3.5.2
-   .. image:: ../../_static/zenodo_cache/6513224.svg
+   .. image:: ../_static/zenodo_cache/6513224.svg
       :target:  https://doi.org/10.5281/zenodo.6513224
 v3.5.1
-   .. image:: ../../_static/zenodo_cache/5773480.svg
+   .. image:: ../_static/zenodo_cache/5773480.svg
       :target:  https://doi.org/10.5281/zenodo.5773480
 v3.5.0
-   .. image:: ../../_static/zenodo_cache/5706396.svg
+   .. image:: ../_static/zenodo_cache/5706396.svg
       :target:  https://doi.org/10.5281/zenodo.5706396
 v3.4.3
-   .. image:: ../../_static/zenodo_cache/5194481.svg
+   .. image:: ../_static/zenodo_cache/5194481.svg
       :target:  https://doi.org/10.5281/zenodo.5194481
 v3.4.2
-   .. image:: ../../_static/zenodo_cache/4743323.svg
+   .. image:: ../_static/zenodo_cache/4743323.svg
       :target:  https://doi.org/10.5281/zenodo.4743323
 v3.4.1
-   .. image:: ../../_static/zenodo_cache/4649959.svg
+   .. image:: ../_static/zenodo_cache/4649959.svg
       :target:  https://doi.org/10.5281/zenodo.4649959
 v3.4.0
-   .. image:: ../../_static/zenodo_cache/4638398.svg
+   .. image:: ../_static/zenodo_cache/4638398.svg
       :target:  https://doi.org/10.5281/zenodo.4638398
 v3.3.4
-   .. image:: ../../_static/zenodo_cache/4475376.svg
+   .. image:: ../_static/zenodo_cache/4475376.svg
       :target:  https://doi.org/10.5281/zenodo.4475376
 v3.3.3
-   .. image:: ../../_static/zenodo_cache/4268928.svg
+   .. image:: ../_static/zenodo_cache/4268928.svg
       :target:  https://doi.org/10.5281/zenodo.4268928
 v3.3.2
-   .. image:: ../../_static/zenodo_cache/4030140.svg
+   .. image:: ../_static/zenodo_cache/4030140.svg
       :target:  https://doi.org/10.5281/zenodo.4030140
 v3.3.1
-   .. image:: ../../_static/zenodo_cache/3984190.svg
+   .. image:: ../_static/zenodo_cache/3984190.svg
       :target:  https://doi.org/10.5281/zenodo.3984190
 v3.3.0
-   .. image:: ../../_static/zenodo_cache/3948793.svg
+   .. image:: ../_static/zenodo_cache/3948793.svg
       :target:  https://doi.org/10.5281/zenodo.3948793
 v3.2.2
-   .. image:: ../../_static/zenodo_cache/3898017.svg
+   .. image:: ../_static/zenodo_cache/3898017.svg
       :target:  https://doi.org/10.5281/zenodo.3898017
 v3.2.1
-   .. image:: ../../_static/zenodo_cache/3714460.svg
+   .. image:: ../_static/zenodo_cache/3714460.svg
       :target:  https://doi.org/10.5281/zenodo.3714460
 v3.2.0
-   .. image:: ../../_static/zenodo_cache/3695547.svg
+   .. image:: ../_static/zenodo_cache/3695547.svg
       :target:  https://doi.org/10.5281/zenodo.3695547
 v3.1.3
-   .. image:: ../../_static/zenodo_cache/3633844.svg
+   .. image:: ../_static/zenodo_cache/3633844.svg
       :target:  https://doi.org/10.5281/zenodo.3633844
 v3.1.2
-   .. image:: ../../_static/zenodo_cache/3563226.svg
+   .. image:: ../_static/zenodo_cache/3563226.svg
       :target:  https://doi.org/10.5281/zenodo.3563226
 v3.1.1
-   .. image:: ../../_static/zenodo_cache/3264781.svg
+   .. image:: ../_static/zenodo_cache/3264781.svg
       :target:  https://doi.org/10.5281/zenodo.3264781
 v3.1.0
-   .. image:: ../../_static/zenodo_cache/2893252.svg
+   .. image:: ../_static/zenodo_cache/2893252.svg
       :target:  https://doi.org/10.5281/zenodo.2893252
 v3.0.3
-   .. image:: ../../_static/zenodo_cache/2577644.svg
+   .. image:: ../_static/zenodo_cache/2577644.svg
       :target:  https://doi.org/10.5281/zenodo.2577644
 v3.0.2
-   .. image:: ../../_static/zenodo_cache/1482099.svg
+   .. image:: ../_static/zenodo_cache/1482099.svg
       :target:  https://doi.org/10.5281/zenodo.1482099
 v3.0.1
-   .. image:: ../../_static/zenodo_cache/1482098.svg
+   .. image:: ../_static/zenodo_cache/1482098.svg
       :target:  https://doi.org/10.5281/zenodo.1482098
 v2.2.5
-   .. image:: ../../_static/zenodo_cache/3633833.svg
+   .. image:: ../_static/zenodo_cache/3633833.svg
       :target:  https://doi.org/10.5281/zenodo.3633833
 v3.0.0
-   .. image:: ../../_static/zenodo_cache/1420605.svg
+   .. image:: ../_static/zenodo_cache/1420605.svg
       :target:  https://doi.org/10.5281/zenodo.1420605
 v2.2.4
-   .. image:: ../../_static/zenodo_cache/2669103.svg
+   .. image:: ../_static/zenodo_cache/2669103.svg
       :target:  https://doi.org/10.5281/zenodo.2669103
 v2.2.3
-   .. image:: ../../_static/zenodo_cache/1343133.svg
+   .. image:: ../_static/zenodo_cache/1343133.svg
       :target:  https://doi.org/10.5281/zenodo.1343133
 v2.2.2
-   .. image:: ../../_static/zenodo_cache/1202077.svg
+   .. image:: ../_static/zenodo_cache/1202077.svg
       :target:  https://doi.org/10.5281/zenodo.1202077
 v2.2.1
-   .. image:: ../../_static/zenodo_cache/1202050.svg
+   .. image:: ../_static/zenodo_cache/1202050.svg
       :target:  https://doi.org/10.5281/zenodo.1202050
 v2.2.0
-   .. image:: ../../_static/zenodo_cache/1189358.svg
+   .. image:: ../_static/zenodo_cache/1189358.svg
       :target:  https://doi.org/10.5281/zenodo.1189358
 v2.1.2
-   .. image:: ../../_static/zenodo_cache/1154287.svg
+   .. image:: ../_static/zenodo_cache/1154287.svg
       :target:  https://doi.org/10.5281/zenodo.1154287
 v2.1.1
-   .. image:: ../../_static/zenodo_cache/1098480.svg
+   .. image:: ../_static/zenodo_cache/1098480.svg
       :target:  https://doi.org/10.5281/zenodo.1098480
 v2.1.0
-   .. image:: ../../_static/zenodo_cache/1004650.svg
+   .. image:: ../_static/zenodo_cache/1004650.svg
       :target:  https://doi.org/10.5281/zenodo.1004650
 v2.0.2
-   .. image:: ../../_static/zenodo_cache/573577.svg
+   .. image:: ../_static/zenodo_cache/573577.svg
       :target:  https://doi.org/10.5281/zenodo.573577
 v2.0.1
-   .. image:: ../../_static/zenodo_cache/570311.svg
+   .. image:: ../_static/zenodo_cache/570311.svg
       :target:  https://doi.org/10.5281/zenodo.570311
 v2.0.0
-   .. image:: ../../_static/zenodo_cache/248351.svg
+   .. image:: ../_static/zenodo_cache/248351.svg
       :target:  https://doi.org/10.5281/zenodo.248351
 v1.5.3
-   .. image:: ../../_static/zenodo_cache/61948.svg
+   .. image:: ../_static/zenodo_cache/61948.svg
       :target:  https://doi.org/10.5281/zenodo.61948
 v1.5.2
-   .. image:: ../../_static/zenodo_cache/56926.svg
+   .. image:: ../_static/zenodo_cache/56926.svg
       :target:  https://doi.org/10.5281/zenodo.56926
 v1.5.1
-   .. image:: ../../_static/zenodo_cache/44579.svg
+   .. image:: ../_static/zenodo_cache/44579.svg
       :target:  https://doi.org/10.5281/zenodo.44579
 v1.5.0
-   .. image:: ../../_static/zenodo_cache/32914.svg
+   .. image:: ../_static/zenodo_cache/32914.svg
       :target:  https://doi.org/10.5281/zenodo.32914
 v1.4.3
-   .. image:: ../../_static/zenodo_cache/15423.svg
+   .. image:: ../_static/zenodo_cache/15423.svg
       :target:  https://doi.org/10.5281/zenodo.15423
 v1.4.2
-   .. image:: ../../_static/zenodo_cache/12400.svg
+   .. image:: ../_static/zenodo_cache/12400.svg
       :target:  https://doi.org/10.5281/zenodo.12400
 v1.4.1
-   .. image:: ../../_static/zenodo_cache/12287.svg
+   .. image:: ../_static/zenodo_cache/12287.svg
       :target:  https://doi.org/10.5281/zenodo.12287
 v1.4.0
-   .. image:: ../../_static/zenodo_cache/11451.svg
+   .. image:: ../_static/zenodo_cache/11451.svg
       :target:  https://doi.org/10.5281/zenodo.11451
 
 .. END OF AUTOGENERATED

doc/users/project/code_of_conduct.rst doc/project/code_of_conduct.rstdoc/users/project/code_of_conduct.rst renamed to doc/project/code_of_conduct.rst

@@ -1,4 +1,5 @@
 .. _code_of_conduct:
+.. redirect-from:: /users/project/code_of_conduct
 
 ====================================
 Contributor Covenant Code of Conduct

doc/users/project/credits.rst doc/project/credits.rstdoc/users/project/credits.rst renamed to doc/project/credits.rst

@@ -1,6 +1,7 @@
 .. Note: This file is auto-generated using generate_credits.py
 
 .. redirect-from:: /users/credits
+.. redirect-from:: /users/project/credits
 
 .. _credits:
 
@@ -13,7 +14,7 @@ Matplotlib was written by John D. Hunter, with contributions from an
 ever-increasing number of users and developers.  The current lead developer is
 Thomas A. Caswell, who is assisted by many `active developers
 <https://www.openhub.net/p/matplotlib/contributors>`_.
-Please also see our instructions on :doc:`/users/project/citing`.
+Please also see our instructions on :doc:`/project/citing`.
 
 The following is a list of contributors extracted from the
 git revision control history of the project:

doc/users/project/history.rst doc/project/history.rstdoc/users/project/history.rst renamed to doc/project/history.rst

@@ -1,4 +1,5 @@
 .. redirect-from:: /users/history
+.. redirect-from:: /users/project/history
 
 .. _project_history: