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

Skip to content

Commit 968e554

Browse files
QuLogicQuLogic
authored
Merge pull request #27560 from shriyakalakata/user_guide_docs
Moved /users/project to /doc/project
2 parents 3ad0bc5 + 4e7956b commit 968e554

14 files changed

+86
-79
lines changed

‎.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ repos:
5858
"--ignore-words",
5959
"ci/codespell-ignore-words.txt",
6060
"--skip",
61-
"doc/users/project/credits.rst"
61+
"doc/project/credits.rst"
6262
]
6363
- repo: https://github.com/pycqa/isort
6464
rev: 5.13.2

‎CODE_OF_CONDUCT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!--placeholder page so Github knows we have a CoC-->
22

33
Our Code of Conduct is at
4-
https://matplotlib.org/stable/users/project/code_of_conduct.html
4+
https://matplotlib.org/stable/project/code_of_conduct.html
55

6-
It is rendered from `doc/users/project/code_of_conduct.rst`
6+
It is rendered from `doc/project/code_of_conduct.rst`

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,5 +69,5 @@ If Matplotlib contributes to a project that leads to publication, please
6969
acknowledge this by citing Matplotlib.
7070

7171
[A ready-made citation
72-
entry](https://matplotlib.org/stable/users/project/citing.html) is
72+
entry](https://matplotlib.org/stable/project/citing.html) is
7373
available.

‎doc/devel/contribute.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ document's URL roughly corresponds to its location in our folder structure:
267267
.. grid-item:: information about the library
268268

269269
* :file:`doc/users/installing/`
270-
* :file:`doc/users/project/`
270+
* :file:`doc/project/`
271271
* :file:`doc/users/resources/`
272272
* :file:`doc/users/faq.rst`
273273
* :file:`doc/devel/`
@@ -304,7 +304,7 @@ Matplotlib's community is built by its members, if you would like to help out
304304
see our :ref:`communications-guidelines`.
305305

306306
If Matplotlib contributes to a project that leads to a scientific publication,
307-
please follow the :doc:`/users/project/citing` guidelines.
307+
please follow the :doc:`/project/citing` guidelines.
308308

309309
If you have developed an extension to Matplotlib, please consider adding it to our
310310
`third party package <https://github.com/matplotlib/mpl-third-party>`_ list.

‎doc/devel/release_guide.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -315,8 +315,8 @@ automatically produce one once the tag is pushed). Add the DOI post-fix and vers
315315
the dictionary in :file:`tools/cache_zenodo_svg.py` and run the script.
316316

317317
This will download the new SVG to :file:`doc/_static/zenodo_cache/{postfix}.svg` and
318-
edit :file:`doc/users/project/citing.rst`. Commit the new SVG, the change to
319-
:file:`tools/cache_zenodo_svg.py`, and the changes to :file:`doc/users/project/citing.rst`
318+
edit :file:`doc/project/citing.rst`. Commit the new SVG, the change to
319+
:file:`tools/cache_zenodo_svg.py`, and the changes to :file:`doc/project/citing.rst`
320320
to the VER-doc branch and push to GitHub. ::
321321

322322
git checkout v3.7.0-doc

‎doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,4 +172,4 @@ About us
172172
.. toctree::
173173
:maxdepth: 2
174174

175-
users/project/index.rst
175+
project/index.rst

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

Lines changed: 57 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
.. redirect-from:: /citing
2+
.. redirect-from:: /users/project/citing
23

34
Citing Matplotlib
45
=================
@@ -8,12 +9,12 @@ please acknowledge this fact by citing `J. D. Hunter, "Matplotlib: A 2D
89
Graphics Environment", Computing in Science & Engineering, vol. 9, no. 3,
910
pp. 90-95, 2007 <https://doi.org/10.1109/MCSE.2007.55>`_.
1011

11-
.. literalinclude:: ../../../CITATION.bib
12+
.. literalinclude:: ../../CITATION.bib
1213
:language: bibtex
1314

1415
.. container:: sphx-glr-download
1516

16-
:download:`Download BibTeX bibliography file: CITATION.bib <../../../CITATION.bib>`
17+
:download:`Download BibTeX bibliography file: CITATION.bib <../../CITATION.bib>`
1718

1819
DOIs
1920
----
@@ -30,166 +31,166 @@ By version
3031
3132
3233
v3.8.1
33-
.. image:: ../../_static/zenodo_cache/10059757.svg
34+
.. image:: ../_static/zenodo_cache/10059757.svg
3435
:target: https://doi.org/10.5281/zenodo.10059757
3536
v3.8.0
36-
.. image:: ../../_static/zenodo_cache/8347255.svg
37+
.. image:: ../_static/zenodo_cache/8347255.svg
3738
:target: https://doi.org/10.5281/zenodo.8347255
3839
v3.7.3
39-
.. image:: ../../_static/zenodo_cache/8336761.svg
40+
.. image:: ../_static/zenodo_cache/8336761.svg
4041
:target: https://doi.org/10.5281/zenodo.8336761
4142
v3.7.2
42-
.. image:: ../../_static/zenodo_cache/8118151.svg
43+
.. image:: ../_static/zenodo_cache/8118151.svg
4344
:target: https://doi.org/10.5281/zenodo.8118151
4445
v3.7.1
45-
.. image:: ../../_static/zenodo_cache/7697899.svg
46+
.. image:: ../_static/zenodo_cache/7697899.svg
4647
:target: https://doi.org/10.5281/zenodo.7697899
4748
v3.7.0
48-
.. image:: ../../_static/zenodo_cache/7637593.svg
49+
.. image:: ../_static/zenodo_cache/7637593.svg
4950
:target: https://doi.org/10.5281/zenodo.7637593
5051
v3.6.3
51-
.. image:: ../../_static/zenodo_cache/7527665.svg
52+
.. image:: ../_static/zenodo_cache/7527665.svg
5253
:target: https://doi.org/10.5281/zenodo.7527665
5354
v3.6.2
54-
.. image:: ../../_static/zenodo_cache/7275322.svg
55+
.. image:: ../_static/zenodo_cache/7275322.svg
5556
:target: https://doi.org/10.5281/zenodo.7275322
5657
v3.6.1
57-
.. image:: ../../_static/zenodo_cache/7162185.svg
58+
.. image:: ../_static/zenodo_cache/7162185.svg
5859
:target: https://doi.org/10.5281/zenodo.7162185
5960
v3.6.0
60-
.. image:: ../../_static/zenodo_cache/7084615.svg
61+
.. image:: ../_static/zenodo_cache/7084615.svg
6162
:target: https://doi.org/10.5281/zenodo.7084615
6263
v3.5.3
63-
.. image:: ../../_static/zenodo_cache/6982547.svg
64+
.. image:: ../_static/zenodo_cache/6982547.svg
6465
:target: https://doi.org/10.5281/zenodo.6982547
6566
v3.5.2
66-
.. image:: ../../_static/zenodo_cache/6513224.svg
67+
.. image:: ../_static/zenodo_cache/6513224.svg
6768
:target: https://doi.org/10.5281/zenodo.6513224
6869
v3.5.1
69-
.. image:: ../../_static/zenodo_cache/5773480.svg
70+
.. image:: ../_static/zenodo_cache/5773480.svg
7071
:target: https://doi.org/10.5281/zenodo.5773480
7172
v3.5.0
72-
.. image:: ../../_static/zenodo_cache/5706396.svg
73+
.. image:: ../_static/zenodo_cache/5706396.svg
7374
:target: https://doi.org/10.5281/zenodo.5706396
7475
v3.4.3
75-
.. image:: ../../_static/zenodo_cache/5194481.svg
76+
.. image:: ../_static/zenodo_cache/5194481.svg
7677
:target: https://doi.org/10.5281/zenodo.5194481
7778
v3.4.2
78-
.. image:: ../../_static/zenodo_cache/4743323.svg
79+
.. image:: ../_static/zenodo_cache/4743323.svg
7980
:target: https://doi.org/10.5281/zenodo.4743323
8081
v3.4.1
81-
.. image:: ../../_static/zenodo_cache/4649959.svg
82+
.. image:: ../_static/zenodo_cache/4649959.svg
8283
:target: https://doi.org/10.5281/zenodo.4649959
8384
v3.4.0
84-
.. image:: ../../_static/zenodo_cache/4638398.svg
85+
.. image:: ../_static/zenodo_cache/4638398.svg
8586
:target: https://doi.org/10.5281/zenodo.4638398
8687
v3.3.4
87-
.. image:: ../../_static/zenodo_cache/4475376.svg
88+
.. image:: ../_static/zenodo_cache/4475376.svg
8889
:target: https://doi.org/10.5281/zenodo.4475376
8990
v3.3.3
90-
.. image:: ../../_static/zenodo_cache/4268928.svg
91+
.. image:: ../_static/zenodo_cache/4268928.svg
9192
:target: https://doi.org/10.5281/zenodo.4268928
9293
v3.3.2
93-
.. image:: ../../_static/zenodo_cache/4030140.svg
94+
.. image:: ../_static/zenodo_cache/4030140.svg
9495
:target: https://doi.org/10.5281/zenodo.4030140
9596
v3.3.1
96-
.. image:: ../../_static/zenodo_cache/3984190.svg
97+
.. image:: ../_static/zenodo_cache/3984190.svg
9798
:target: https://doi.org/10.5281/zenodo.3984190
9899
v3.3.0
99-
.. image:: ../../_static/zenodo_cache/3948793.svg
100+
.. image:: ../_static/zenodo_cache/3948793.svg
100101
:target: https://doi.org/10.5281/zenodo.3948793
101102
v3.2.2
102-
.. image:: ../../_static/zenodo_cache/3898017.svg
103+
.. image:: ../_static/zenodo_cache/3898017.svg
103104
:target: https://doi.org/10.5281/zenodo.3898017
104105
v3.2.1
105-
.. image:: ../../_static/zenodo_cache/3714460.svg
106+
.. image:: ../_static/zenodo_cache/3714460.svg
106107
:target: https://doi.org/10.5281/zenodo.3714460
107108
v3.2.0
108-
.. image:: ../../_static/zenodo_cache/3695547.svg
109+
.. image:: ../_static/zenodo_cache/3695547.svg
109110
:target: https://doi.org/10.5281/zenodo.3695547
110111
v3.1.3
111-
.. image:: ../../_static/zenodo_cache/3633844.svg
112+
.. image:: ../_static/zenodo_cache/3633844.svg
112113
:target: https://doi.org/10.5281/zenodo.3633844
113114
v3.1.2
114-
.. image:: ../../_static/zenodo_cache/3563226.svg
115+
.. image:: ../_static/zenodo_cache/3563226.svg
115116
:target: https://doi.org/10.5281/zenodo.3563226
116117
v3.1.1
117-
.. image:: ../../_static/zenodo_cache/3264781.svg
118+
.. image:: ../_static/zenodo_cache/3264781.svg
118119
:target: https://doi.org/10.5281/zenodo.3264781
119120
v3.1.0
120-
.. image:: ../../_static/zenodo_cache/2893252.svg
121+
.. image:: ../_static/zenodo_cache/2893252.svg
121122
:target: https://doi.org/10.5281/zenodo.2893252
122123
v3.0.3
123-
.. image:: ../../_static/zenodo_cache/2577644.svg
124+
.. image:: ../_static/zenodo_cache/2577644.svg
124125
:target: https://doi.org/10.5281/zenodo.2577644
125126
v3.0.2
126-
.. image:: ../../_static/zenodo_cache/1482099.svg
127+
.. image:: ../_static/zenodo_cache/1482099.svg
127128
:target: https://doi.org/10.5281/zenodo.1482099
128129
v3.0.1
129-
.. image:: ../../_static/zenodo_cache/1482098.svg
130+
.. image:: ../_static/zenodo_cache/1482098.svg
130131
:target: https://doi.org/10.5281/zenodo.1482098
131132
v2.2.5
132-
.. image:: ../../_static/zenodo_cache/3633833.svg
133+
.. image:: ../_static/zenodo_cache/3633833.svg
133134
:target: https://doi.org/10.5281/zenodo.3633833
134135
v3.0.0
135-
.. image:: ../../_static/zenodo_cache/1420605.svg
136+
.. image:: ../_static/zenodo_cache/1420605.svg
136137
:target: https://doi.org/10.5281/zenodo.1420605
137138
v2.2.4
138-
.. image:: ../../_static/zenodo_cache/2669103.svg
139+
.. image:: ../_static/zenodo_cache/2669103.svg
139140
:target: https://doi.org/10.5281/zenodo.2669103
140141
v2.2.3
141-
.. image:: ../../_static/zenodo_cache/1343133.svg
142+
.. image:: ../_static/zenodo_cache/1343133.svg
142143
:target: https://doi.org/10.5281/zenodo.1343133
143144
v2.2.2
144-
.. image:: ../../_static/zenodo_cache/1202077.svg
145+
.. image:: ../_static/zenodo_cache/1202077.svg
145146
:target: https://doi.org/10.5281/zenodo.1202077
146147
v2.2.1
147-
.. image:: ../../_static/zenodo_cache/1202050.svg
148+
.. image:: ../_static/zenodo_cache/1202050.svg
148149
:target: https://doi.org/10.5281/zenodo.1202050
149150
v2.2.0
150-
.. image:: ../../_static/zenodo_cache/1189358.svg
151+
.. image:: ../_static/zenodo_cache/1189358.svg
151152
:target: https://doi.org/10.5281/zenodo.1189358
152153
v2.1.2
153-
.. image:: ../../_static/zenodo_cache/1154287.svg
154+
.. image:: ../_static/zenodo_cache/1154287.svg
154155
:target: https://doi.org/10.5281/zenodo.1154287
155156
v2.1.1
156-
.. image:: ../../_static/zenodo_cache/1098480.svg
157+
.. image:: ../_static/zenodo_cache/1098480.svg
157158
:target: https://doi.org/10.5281/zenodo.1098480
158159
v2.1.0
159-
.. image:: ../../_static/zenodo_cache/1004650.svg
160+
.. image:: ../_static/zenodo_cache/1004650.svg
160161
:target: https://doi.org/10.5281/zenodo.1004650
161162
v2.0.2
162-
.. image:: ../../_static/zenodo_cache/573577.svg
163+
.. image:: ../_static/zenodo_cache/573577.svg
163164
:target: https://doi.org/10.5281/zenodo.573577
164165
v2.0.1
165-
.. image:: ../../_static/zenodo_cache/570311.svg
166+
.. image:: ../_static/zenodo_cache/570311.svg
166167
:target: https://doi.org/10.5281/zenodo.570311
167168
v2.0.0
168-
.. image:: ../../_static/zenodo_cache/248351.svg
169+
.. image:: ../_static/zenodo_cache/248351.svg
169170
:target: https://doi.org/10.5281/zenodo.248351
170171
v1.5.3
171-
.. image:: ../../_static/zenodo_cache/61948.svg
172+
.. image:: ../_static/zenodo_cache/61948.svg
172173
:target: https://doi.org/10.5281/zenodo.61948
173174
v1.5.2
174-
.. image:: ../../_static/zenodo_cache/56926.svg
175+
.. image:: ../_static/zenodo_cache/56926.svg
175176
:target: https://doi.org/10.5281/zenodo.56926
176177
v1.5.1
177-
.. image:: ../../_static/zenodo_cache/44579.svg
178+
.. image:: ../_static/zenodo_cache/44579.svg
178179
:target: https://doi.org/10.5281/zenodo.44579
179180
v1.5.0
180-
.. image:: ../../_static/zenodo_cache/32914.svg
181+
.. image:: ../_static/zenodo_cache/32914.svg
181182
:target: https://doi.org/10.5281/zenodo.32914
182183
v1.4.3
183-
.. image:: ../../_static/zenodo_cache/15423.svg
184+
.. image:: ../_static/zenodo_cache/15423.svg
184185
:target: https://doi.org/10.5281/zenodo.15423
185186
v1.4.2
186-
.. image:: ../../_static/zenodo_cache/12400.svg
187+
.. image:: ../_static/zenodo_cache/12400.svg
187188
:target: https://doi.org/10.5281/zenodo.12400
188189
v1.4.1
189-
.. image:: ../../_static/zenodo_cache/12287.svg
190+
.. image:: ../_static/zenodo_cache/12287.svg
190191
:target: https://doi.org/10.5281/zenodo.12287
191192
v1.4.0
192-
.. image:: ../../_static/zenodo_cache/11451.svg
193+
.. image:: ../_static/zenodo_cache/11451.svg
193194
:target: https://doi.org/10.5281/zenodo.11451
194195

195196
.. END OF AUTOGENERATED

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
.. _code_of_conduct:
2+
.. redirect-from:: /users/project/code_of_conduct
23

34
====================================
45
Contributor Covenant Code of Conduct

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
.. Note: This file is auto-generated using generate_credits.py
22
33
.. redirect-from:: /users/credits
4+
.. redirect-from:: /users/project/credits
45

56
.. _credits:
67

@@ -13,7 +14,7 @@ Matplotlib was written by John D. Hunter, with contributions from an
1314
ever-increasing number of users and developers. The current lead developer is
1415
Thomas A. Caswell, who is assisted by many `active developers
1516
<https://www.openhub.net/p/matplotlib/contributors>`_.
16-
Please also see our instructions on :doc:`/users/project/citing`.
17+
Please also see our instructions on :doc:`/project/citing`.
1718

1819
The following is a list of contributors extracted from the
1920
git revision control history of the project:

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
.. redirect-from:: /users/history
2+
.. redirect-from:: /users/project/history
23

34
.. _project_history:
45

‎doc/users/project/index.rst renamed to ‎doc/project/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
.. redirect-from:: /users/backmatter
2+
.. redirect-from:: /users/project/index
23

34
Project information
45
===================

0 commit comments

Comments
 (0)