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

Skip to content

Commit 2420ba7

Browse files
jklymakjklymak
committed
DOC: more subdirectories
1 parent 7eb99af commit 2420ba7

24 files changed

+94
-73
lines changed

‎INSTALL.rst

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,6 @@
22
Installation
33
############
44

5-
.. toctree::
6-
:hidden:
7-
8-
installing_source.rst
9-
../faq/installing_faq.rst
10-
11-
125
==============================
136
Installing an official release
147
==============================

‎doc/api/prev_api_changes/api_changes_3.1.0.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@ FreeType or libpng are not in the compiler or linker's default path, set the
308308
standard environment variables ``CFLAGS``/``LDFLAGS`` on Linux or OSX, or
309309
``CL``/``LINK`` on Windows, to indicate the relevant paths.
310310

311-
See details in :doc:`/users/installing`.
311+
See details in :doc:`/users/installing/index`.
312312

313313
Setting artist properties twice or more in the same call
314314
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

‎doc/devel/contributing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ Other ways to contribute
265265
It also helps us if you spread the word: reference the project from your blog
266266
and articles or link to it from your website! If Matplotlib contributes to a
267267
project that leads to a scientific publication, please follow the
268-
:doc:`/citing` guidelines.
268+
:doc:`/users/backmatter/citing` guidelines.
269269

270270
.. _coding_guidelines:
271271

‎doc/devel/documenting_mpl.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -189,14 +189,14 @@ Documents can be linked with the ``:doc:`` directive:
189189
190190
will render as:
191191

192-
See the :doc:`/faq/installing_faq`
192+
See the :doc:`/users/faq/installing_faq`
193193

194194
See the tutorial :doc:`/tutorials/introductory/sample_plots`
195195

196196
See the example :doc:`/gallery/lines_bars_and_markers/simple_plot`
197197

198198
Sections can also be given reference names. For instance from the
199-
:doc:`/faq/installing_faq` link:
199+
:doc:`/users/faq/installing_faq` link:
200200

201201
.. code-block:: rst
202202

‎doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Installation
3838
pip install matplotlib
3939
4040
41-
Further details are available in the :doc:`Installation Guide <users/installing>`.
41+
Further details are available in the :doc:`Installation Guide <users/installing/index>`.
4242

4343

4444
Learning resources

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

Lines changed: 42 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
.. redirect-from:: /citing
22

3-
43
Citing Matplotlib
54
=================
65

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

12-
.. literalinclude:: ../CITATION.bib
11+
.. literalinclude:: ../../../CITATION.bib
1312
:language: bibtex
1413

1514
.. container:: sphx-glr-download
1615

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

1918
DOIs
2019
----
@@ -31,124 +30,124 @@ By version
3130
3231
3332
v3.4.3
34-
.. image:: _static/zenodo_cache/5194481.svg
33+
.. image:: ../../_static/zenodo_cache/5194481.svg
3534
:target: https://doi.org/10.5281/zenodo.5194481
3635
v3.4.2
37-
.. image:: _static/zenodo_cache/4743323.svg
36+
.. image:: ../../_static/zenodo_cache/4743323.svg
3837
:target: https://doi.org/10.5281/zenodo.4743323
3938
v3.4.1
40-
.. image:: _static/zenodo_cache/4649959.svg
39+
.. image:: ../../_static/zenodo_cache/4649959.svg
4140
:target: https://doi.org/10.5281/zenodo.4649959
4241
v3.4.0
43-
.. image:: _static/zenodo_cache/4638398.svg
42+
.. image:: ../../_static/zenodo_cache/4638398.svg
4443
:target: https://doi.org/10.5281/zenodo.4638398
4544
v3.3.4
46-
.. image:: _static/zenodo_cache/4475376.svg
45+
.. image:: ../../_static/zenodo_cache/4475376.svg
4746
:target: https://doi.org/10.5281/zenodo.4475376
4847
v3.3.3
49-
.. image:: _static/zenodo_cache/4268928.svg
48+
.. image:: ../../_static/zenodo_cache/4268928.svg
5049
:target: https://doi.org/10.5281/zenodo.4268928
5150
v3.3.2
52-
.. image:: _static/zenodo_cache/4030140.svg
51+
.. image:: ../../_static/zenodo_cache/4030140.svg
5352
:target: https://doi.org/10.5281/zenodo.4030140
5453
v3.3.1
55-
.. image:: _static/zenodo_cache/3984190.svg
54+
.. image:: ../../_static/zenodo_cache/3984190.svg
5655
:target: https://doi.org/10.5281/zenodo.3984190
5756
v3.3.0
58-
.. image:: _static/zenodo_cache/3948793.svg
57+
.. image:: ../../_static/zenodo_cache/3948793.svg
5958
:target: https://doi.org/10.5281/zenodo.3948793
6059
v3.2.2
61-
.. image:: _static/zenodo_cache/3898017.svg
60+
.. image:: ../../_static/zenodo_cache/3898017.svg
6261
:target: https://doi.org/10.5281/zenodo.3898017
6362
v3.2.1
64-
.. image:: _static/zenodo_cache/3714460.svg
63+
.. image:: ../../_static/zenodo_cache/3714460.svg
6564
:target: https://doi.org/10.5281/zenodo.3714460
6665
v3.2.0
67-
.. image:: _static/zenodo_cache/3695547.svg
66+
.. image:: ../../_static/zenodo_cache/3695547.svg
6867
:target: https://doi.org/10.5281/zenodo.3695547
6968
v3.1.3
70-
.. image:: _static/zenodo_cache/3633844.svg
69+
.. image:: ../../_static/zenodo_cache/3633844.svg
7170
:target: https://doi.org/10.5281/zenodo.3633844
7271
v3.1.2
73-
.. image:: _static/zenodo_cache/3563226.svg
72+
.. image:: ../../_static/zenodo_cache/3563226.svg
7473
:target: https://doi.org/10.5281/zenodo.3563226
7574
v3.1.1
76-
.. image:: _static/zenodo_cache/3264781.svg
75+
.. image:: ../../_static/zenodo_cache/3264781.svg
7776
:target: https://doi.org/10.5281/zenodo.3264781
7877
v3.1.0
79-
.. image:: _static/zenodo_cache/2893252.svg
78+
.. image:: ../../_static/zenodo_cache/2893252.svg
8079
:target: https://doi.org/10.5281/zenodo.2893252
8180
v3.0.3
82-
.. image:: _static/zenodo_cache/2577644.svg
81+
.. image:: ../../_static/zenodo_cache/2577644.svg
8382
:target: https://doi.org/10.5281/zenodo.2577644
8483
v3.0.2
85-
.. image:: _static/zenodo_cache/1482099.svg
84+
.. image:: ../../_static/zenodo_cache/1482099.svg
8685
:target: https://doi.org/10.5281/zenodo.1482099
8786
v3.0.1
88-
.. image:: _static/zenodo_cache/1482098.svg
87+
.. image:: ../../_static/zenodo_cache/1482098.svg
8988
:target: https://doi.org/10.5281/zenodo.1482098
9089
v2.2.5
91-
.. image:: _static/zenodo_cache/3633833.svg
90+
.. image:: ../../_static/zenodo_cache/3633833.svg
9291
:target: https://doi.org/10.5281/zenodo.3633833
9392
v3.0.0
94-
.. image:: _static/zenodo_cache/1420605.svg
93+
.. image:: ../../_static/zenodo_cache/1420605.svg
9594
:target: https://doi.org/10.5281/zenodo.1420605
9695
v2.2.4
97-
.. image:: _static/zenodo_cache/2669103.svg
96+
.. image:: ../../_static/zenodo_cache/2669103.svg
9897
:target: https://doi.org/10.5281/zenodo.2669103
9998
v2.2.3
100-
.. image:: _static/zenodo_cache/1343133.svg
99+
.. image:: ../../_static/zenodo_cache/1343133.svg
101100
:target: https://doi.org/10.5281/zenodo.1343133
102101
v2.2.2
103-
.. image:: _static/zenodo_cache/1202077.svg
102+
.. image:: ../../_static/zenodo_cache/1202077.svg
104103
:target: https://doi.org/10.5281/zenodo.1202077
105104
v2.2.1
106-
.. image:: _static/zenodo_cache/1202050.svg
105+
.. image:: ../../_static/zenodo_cache/1202050.svg
107106
:target: https://doi.org/10.5281/zenodo.1202050
108107
v2.2.0
109-
.. image:: _static/zenodo_cache/1189358.svg
108+
.. image:: ../../_static/zenodo_cache/1189358.svg
110109
:target: https://doi.org/10.5281/zenodo.1189358
111110
v2.1.2
112-
.. image:: _static/zenodo_cache/1154287.svg
111+
.. image:: ../../_static/zenodo_cache/1154287.svg
113112
:target: https://doi.org/10.5281/zenodo.1154287
114113
v2.1.1
115-
.. image:: _static/zenodo_cache/1098480.svg
114+
.. image:: ../../_static/zenodo_cache/1098480.svg
116115
:target: https://doi.org/10.5281/zenodo.1098480
117116
v2.1.0
118-
.. image:: _static/zenodo_cache/1004650.svg
117+
.. image:: ../../_static/zenodo_cache/1004650.svg
119118
:target: https://doi.org/10.5281/zenodo.1004650
120119
v2.0.2
121-
.. image:: _static/zenodo_cache/573577.svg
120+
.. image:: ../../_static/zenodo_cache/573577.svg
122121
:target: https://doi.org/10.5281/zenodo.573577
123122
v2.0.1
124-
.. image:: _static/zenodo_cache/570311.svg
123+
.. image:: ../../_static/zenodo_cache/570311.svg
125124
:target: https://doi.org/10.5281/zenodo.570311
126125
v2.0.0
127-
.. image:: _static/zenodo_cache/248351.svg
126+
.. image:: ../../_static/zenodo_cache/248351.svg
128127
:target: https://doi.org/10.5281/zenodo.248351
129128
v1.5.3
130-
.. image:: _static/zenodo_cache/61948.svg
129+
.. image:: ../../_static/zenodo_cache/61948.svg
131130
:target: https://doi.org/10.5281/zenodo.61948
132131
v1.5.2
133-
.. image:: _static/zenodo_cache/56926.svg
132+
.. image:: ../../_static/zenodo_cache/56926.svg
134133
:target: https://doi.org/10.5281/zenodo.56926
135134
v1.5.1
136-
.. image:: _static/zenodo_cache/44579.svg
135+
.. image:: ../../_static/zenodo_cache/44579.svg
137136
:target: https://doi.org/10.5281/zenodo.44579
138137
v1.5.0
139-
.. image:: _static/zenodo_cache/32914.svg
138+
.. image:: ../../_static/zenodo_cache/32914.svg
140139
:target: https://doi.org/10.5281/zenodo.32914
141140
v1.4.3
142-
.. image:: _static/zenodo_cache/15423.svg
141+
.. image:: ../../_static/zenodo_cache/15423.svg
143142
:target: https://doi.org/10.5281/zenodo.15423
144143
v1.4.2
145-
.. image:: _static/zenodo_cache/12400.svg
144+
.. image:: ../../_static/zenodo_cache/12400.svg
146145
:target: https://doi.org/10.5281/zenodo.12400
147146
v1.4.1
148-
.. image:: _static/zenodo_cache/12287.svg
147+
.. image:: ../../_static/zenodo_cache/12287.svg
149148
:target: https://doi.org/10.5281/zenodo.12287
150149
v1.4.0
151-
.. image:: _static/zenodo_cache/11451.svg
150+
.. image:: ../../_static/zenodo_cache/11451.svg
152151
:target: https://doi.org/10.5281/zenodo.11451
153152

154153
.. END OF AUTOGENERATED

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.. Note: This file is auto-generated using generate_credits.py
22
3+
.. redirect-from:: /users/credits
4+
35
.. _credits:
46

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

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

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. redirect-from:: /users/history
2+
13
History
24
=======
35

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
.. redirect-from:: /users/backmatter
12

23
Project information
34
-------------------

‎doc/users/license.rst renamed to ‎doc/users/backmatter/license.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.. _license:
22

3+
.. redirect-from:: /users/license
4+
35
*******
46
License
57
*******
@@ -44,5 +46,5 @@ control logs.
4446
License agreement
4547
=================
4648

47-
.. literalinclude:: ../../LICENSE/LICENSE
49+
.. literalinclude:: ../../../LICENSE/LICENSE
4850
:language: none

‎doc/users/event_handling.rst renamed to ‎doc/users/explain/event_handling.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. redirect-from:: /users/event_handling
2+
13
.. _event-handling-tutorial:
24

35
**************************

‎doc/users/fonts.rst renamed to ‎doc/users/explain/fonts.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. redirect-from:: /users/fonts
2+
13
Fonts in Matplotlib text engine
24
===============================
35

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.. _users-guide-explain:
22

3+
.. redirect-from:: /users/explain
4+
35
Explanations
46
------------
57

‎doc/users/interactive.rst renamed to ‎doc/users/explain/interactive.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. redirect-from:: /users/interactive
2+
13
.. currentmodule:: matplotlib
24

35
.. _mpl-shell:

‎doc/users/interactive_guide.rst renamed to ‎doc/users/explain/interactive_guide.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.. _interactive_figures_and_eventloops:
22

3+
.. redirect-from:: /users/interactive_guide
4+
35
.. currentmodule:: matplotlib
46

57

‎doc/users/faq/howto_faq.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,8 +150,8 @@ behavior by specifying the coordinates of the label. The example
150150
below shows the default behavior in the left subplots, and the manual
151151
setting in the right subplots.
152152

153-
.. figure:: ../gallery/pyplots/images/sphx_glr_align_ylabels_001.png
154-
:target: ../gallery/pyplots/align_ylabels.html
153+
.. figure:: ../../gallery/pyplots/images/sphx_glr_align_ylabels_001.png
154+
:target: ../../gallery/pyplots/align_ylabels.html
155155
:align: center
156156
:scale: 50
157157

‎doc/users/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ Users guide
1010
.. toctree::
1111
:maxdepth: 2
1212

13-
installing.rst
13+
installing/index.rst
1414
../plot_types/index.rst
1515
../tutorials/index.rst
1616
../gallery/index.rst
17-
explain.rst
17+
explain/index.rst
1818
faq/index.rst
1919
../api/index.rst
2020
resources/index.rst
2121
../devel/index.rst
22-
backmatter.rst
22+
backmatter/index.rst
2323
release_notes.rst

‎doc/users/installing.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎doc/users/installing/index.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. redirect-from:: /installing
2+
3+
4+
.. toctree::
5+
:hidden:
6+
7+
installing_source.rst
8+
../faq/installing_faq.rst
9+
10+
.. include:: ../../../INSTALL.rst

‎doc/users/installing_source.rst renamed to ‎doc/users/installing/installing_source.rst

File renamed without changes.

‎doc/users/dflt_style_changes.rst renamed to ‎doc/users/prev_whats_new/dflt_style_changes.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. redirect-from:: /users/dflt_style_changes
2+
13
==============================
24
Changes to the default style
35
==============================

‎doc/users/prev_whats_new/whats_new_2.0.0.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The major changes in v2.0 are related to overhauling the default styles.
1717
.. toctree::
1818
:maxdepth: 2
1919

20-
../dflt_style_changes
20+
dflt_style_changes
2121

2222

2323
Improved color conversion API and RGBA support

‎examples/event_handling/README.txt

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@
33
Event handling
44
==============
55

6-
Matplotlib supports :doc:`event handling</users/event_handling>` with a GUI
7-
neutral event model, so you can connect to Matplotlib events without knowledge
8-
of what user interface Matplotlib will ultimately be plugged in to. This has
9-
two advantages: the code you write will be more portable, and Matplotlib events
10-
are aware of things like data coordinate space and which axes the event occurs
11-
in so you don't have to mess with low level transformation details to go from
12-
canvas space to data space. Object picking examples are also included.
6+
Matplotlib supports :doc:`event handling</users/explain/event_handling>` with
7+
a GUI neutral event model, so you can connect to Matplotlib events without
8+
knowledge of what user interface Matplotlib will ultimately be plugged in to.
9+
This has two advantages: the code you write will be more portable, and
10+
Matplotlib events are aware of things like data coordinate space and which
11+
axes the event occurs in so you don't have to mess with low level
12+
transformation details to go from canvas space to data space. Object picking
13+
examples are also included.

0 commit comments

Comments
 (0)