diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index aba2f7462223..45d9aaa32591 100644 --- a/.pre-commit-config.yaml +++ b/.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 diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 657eb14336b9..8fbbe8e7d6f3 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,6 +1,6 @@ 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` diff --git a/README.md b/README.md index 5e15c645c9a2..fc3abb7e197c 100644 --- a/README.md +++ b/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. diff --git a/doc/devel/contribute.rst b/doc/devel/contribute.rst index b582aa455341..510b67eead91 100644 --- a/doc/devel/contribute.rst +++ b/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 `_ list. diff --git a/doc/devel/release_guide.rst b/doc/devel/release_guide.rst index 4adc4546e879..77739100c1ce 100644 --- a/doc/devel/release_guide.rst +++ b/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 diff --git a/doc/index.rst b/doc/index.rst index 4f42273d3dcc..00814b5ccc71 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -172,4 +172,4 @@ About us .. toctree:: :maxdepth: 2 - users/project/index.rst + project/index.rst diff --git a/doc/users/project/citing.rst b/doc/project/citing.rst similarity index 58% rename from doc/users/project/citing.rst rename to doc/project/citing.rst index d6b924afec2f..65fc3db413f0 100644 --- a/doc/users/project/citing.rst +++ b/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 `_. -.. 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 diff --git a/doc/users/project/code_of_conduct.rst b/doc/project/code_of_conduct.rst similarity index 99% rename from doc/users/project/code_of_conduct.rst rename to doc/project/code_of_conduct.rst index ac8b268a4e30..56fee2f25f6f 100644 --- a/doc/users/project/code_of_conduct.rst +++ b/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 diff --git a/doc/users/project/credits.rst b/doc/project/credits.rst similarity index 99% rename from doc/users/project/credits.rst rename to doc/project/credits.rst index c23d6ac11298..a57c35e8127d 100644 --- a/doc/users/project/credits.rst +++ b/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 `_. -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: diff --git a/doc/users/project/history.rst b/doc/project/history.rst similarity index 99% rename from doc/users/project/history.rst rename to doc/project/history.rst index 18a94793736f..966b7a3caa38 100644 --- a/doc/users/project/history.rst +++ b/doc/project/history.rst @@ -1,4 +1,5 @@ .. redirect-from:: /users/history +.. redirect-from:: /users/project/history .. _project_history: diff --git a/doc/users/project/index.rst b/doc/project/index.rst similarity index 85% rename from doc/users/project/index.rst rename to doc/project/index.rst index ad55576190ab..c7e230339dc9 100644 --- a/doc/users/project/index.rst +++ b/doc/project/index.rst @@ -1,4 +1,5 @@ .. redirect-from:: /users/backmatter +.. redirect-from:: /users/project/index Project information =================== diff --git a/doc/users/project/license.rst b/doc/project/license.rst similarity index 81% rename from doc/users/project/license.rst rename to doc/project/license.rst index 3f9c1e30531b..1005b5467b5a 100644 --- a/doc/users/project/license.rst +++ b/doc/project/license.rst @@ -1,6 +1,7 @@ .. _license: .. redirect-from:: /users/license +.. redirect-from:: /users/project/license ******* License @@ -50,7 +51,7 @@ License agreement :open: :class-container: sdd - .. literalinclude:: ../../../LICENSE/LICENSE + .. literalinclude:: ../../LICENSE/LICENSE :language: none @@ -61,13 +62,13 @@ Bundled software .. dropdown:: JSX Tools Resize Observer :class-container: sdd - .. literalinclude:: ../../../LICENSE/LICENSE_JSXTOOLS_RESIZE_OBSERVER + .. literalinclude:: ../../LICENSE/LICENSE_JSXTOOLS_RESIZE_OBSERVER :language: none .. dropdown:: QT4 Editor :class-container: sdd - .. literalinclude:: ../../../LICENSE/LICENSE_QT4_EDITOR + .. literalinclude:: ../../LICENSE/LICENSE_QT4_EDITOR :language: none @@ -79,19 +80,19 @@ Colormaps and themes .. dropdown:: ColorBrewer :class-container: sdd - .. literalinclude:: ../../../LICENSE/LICENSE_COLORBREWER + .. literalinclude:: ../../LICENSE/LICENSE_COLORBREWER :language: none .. dropdown:: Solarized :class-container: sdd - .. literalinclude:: ../../../LICENSE/LICENSE_SOLARIZED + .. literalinclude:: ../../LICENSE/LICENSE_SOLARIZED :language: none .. dropdown:: Yorick :class-container: sdd - .. literalinclude:: ../../../LICENSE/LICENSE_YORICK + .. literalinclude:: ../../LICENSE/LICENSE_YORICK :language: none @@ -103,29 +104,29 @@ Fonts .. dropdown:: American Mathematical Society (AMS) fonts :class-container: sdd - .. literalinclude:: ../../../LICENSE/LICENSE_AMSFONTS + .. literalinclude:: ../../LICENSE/LICENSE_AMSFONTS :language: none .. dropdown:: BaKoMa :class-container: sdd - .. literalinclude:: ../../../LICENSE/LICENSE_BAKOMA + .. literalinclude:: ../../LICENSE/LICENSE_BAKOMA :language: none .. dropdown:: Carlogo :class-container: sdd - .. literalinclude:: ../../../LICENSE/LICENSE_CARLOGO + .. literalinclude:: ../../LICENSE/LICENSE_CARLOGO :language: none .. dropdown:: Courier 10 :class-container: sdd - .. literalinclude:: ../../../LICENSE/LICENSE_COURIERTEN + .. literalinclude:: ../../LICENSE/LICENSE_COURIERTEN :language: none .. dropdown:: STIX :class-container: sdd - .. literalinclude:: ../../../LICENSE/LICENSE_STIX + .. literalinclude:: ../../LICENSE/LICENSE_STIX :language: none diff --git a/doc/users/project/mission.rst b/doc/project/mission.rst similarity index 95% rename from doc/users/project/mission.rst rename to doc/project/mission.rst index 438d2fce8b1d..1b7a68afcc67 100644 --- a/doc/users/project/mission.rst +++ b/doc/project/mission.rst @@ -1,4 +1,5 @@ .. _mission-statement: +.. redirect-from:: /users/project/mission Mission Statement ================= diff --git a/tools/cache_zenodo_svg.py b/tools/cache_zenodo_svg.py index cbd1304bd14c..77a3ea629a46 100644 --- a/tools/cache_zenodo_svg.py +++ b/tools/cache_zenodo_svg.py @@ -120,7 +120,7 @@ def _get_xdg_cache_dir(): } doc_dir = Path(__file__).parent.parent.absolute() / "doc" target_dir = doc_dir / "_static/zenodo_cache" - citing = doc_dir / "users/project/citing.rst" + citing = doc_dir / "project/citing.rst" target_dir.mkdir(exist_ok=True, parents=True) header = [] footer = [] @@ -148,7 +148,7 @@ def _get_xdg_cache_dir(): fout.write( f""" {version} - .. image:: ../../_static/zenodo_cache/{doi}.svg + .. image:: ../_static/zenodo_cache/{doi}.svg :target: https://doi.org/10.5281/zenodo.{doi}""" ) fout.write("\n\n")