10000 DOC: re-arrange user's guide and index · matplotlib/matplotlib@6642e89 · GitHub
[go: up one dir, main page]
Skip to content

Commit 6642e89

Browse files
tacaswelltacaswell
committed
DOC: re-arrange user's guide and index
1 parent c423658 commit 6642e89

File tree

4 files changed

+74
-24
lines changed

4 files changed

+74
-24
lines changed

‎doc/contents.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ Contents
2020
tutorials/index.rst
2121
api/index.rst
2222
users/index.rst
23-
devel/index.rst
24-
Third-party packages <https://matplotlib.org/mpl-third-party/>
2523

2624
.. only:: html
2725

‎doc/index.rst

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
.. module:: matplotlib
66

7-
Matplotlib documentation
7+
Matplotlib documentation
88
------------------------
99

1010
Release: |release|
@@ -14,19 +14,20 @@ and interactive visualizations in Python.
1414

1515
Learn
1616
=====
17-
17+
1818
- :doc:`Quick-start Guide <tutorials/introductory/usage>`
1919
- Basic :doc:`Plot Types <plot_types/index>` and :doc:`Example Gallery <gallery/index>`
2020
- `Introductory Tutorials <../tutorials/index.html#introductory>`_
2121
- :doc:`External Learning Resources <resources/index>`
22-
22+
23+
2324
Reference
2425
=========
2526

2627
- :doc:`API Reference <api/index>`
2728

28-
- :doc:`pyplot API <api/pyplot_summary>`: top-level interface to create
29-
Figures (`.pyplot.figure`) and Subplots (`.pyplot.subplots`,
29+
- :doc:`pyplot API <api/pyplot_summary>`: top-level interface to create
30+
Figures (`.pyplot.figure`) and Subplots (`.pyplot.subplots`,
3031
`.pyplot.subplot_mosaic`)
3132
- :doc:`Axes API <api/axes_api>` for *most* plotting methods
3233
- :doc:`Figure API <api/figure_api>` for figure-level methods
@@ -43,4 +44,23 @@ How-tos
4344
Understand how Matplotlib works
4445
===============================
4546

47+
- The :ref:`users-guide-explain` section of the :doc:`Users guid <users/inedx>`
4648
- Many of the :doc:`Tutorials <tutorials/index>` have explanatory material
49+
50+
51+
Third-party Packages
52+
--------------------
53+
54+
There are many `Third-party packages
55+
<https://matplotlib.org/mpl-third-party/>`_ built on top of and extending
56+
Matplotlib.
57+
58+
59+
Contributing
60+
------------
61+
62+
63+
.. toctree::
64+
:maxdepth: 2
65+
66+
devel/index.rst

‎doc/users/index.rst

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,44 @@ User's guide
99
:Release: |version|
1010
:Date: |today|
1111

12+
Release Notes
13+
-------------
14+
1215
.. toctree::
13-
:maxdepth: 2
16+
:maxdepth: 3
17+
18+
release_notes.rst
19+
20+
.. _users-guide-explain:
21+
22+
Explanations
23+
------------
24+
25+
.. toctree::
26+
:maxdepth: 1
1427

1528
interactive.rst
1629
fonts.rst
17-
release_notes.rst
30+
31+
32+
FAQ and External Resources
33+
--------------------------
34+
35+
.. toctree::
36+
:maxdepth: 2
37+
38+
../faq/index.rst
39+
../resources/index.rst
40+
41+
42+
43+
Back Matter
44+
-----------
45+
46+
.. toctree::
47+
:maxdepth: 1
48+
1849
license.rst
1950
../citing.rst
20-
../resources/index.rst
21-
../faq/index.rst
2251
credits.rst
2352
history.rst

‎doc/users/release_notes.rst

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,11 @@ Release notes
3434
prev_whats_new/github_stats_3.3.1.rst
3535
prev_whats_new/github_stats_3.3.0.rst
3636

37+
Previous
38+
========
39+
3740
3.2
38-
===
41+
***
3942
.. toctree::
4043
:maxdepth: 1
4144

@@ -46,7 +49,7 @@ Release notes
4649
prev_whats_new/github_stats_3.2.0.rst
4750

4851
3.1
49-
===
52+
***
5053
.. toctree::
5154
:maxdepth: 1
5255

@@ -58,7 +61,7 @@ Release notes
5861
prev_whats_new/github_stats_3.1.0.rst
5962

6063
3.0
61-
===
64+
***
6265
.. toctree::
6366
:maxdepth: 1
6467

@@ -68,15 +71,15 @@ Release notes
6871
prev_whats_new/github_stats_3.0.2.rst
6972

7073
2.2
71-
===
74+
***
7275
.. toctree::
7376
:maxdepth: 1
7477

7578
prev_whats_new/whats_new_2.2.rst
7679
../api/prev_api_changes/api_changes_2.2.0.rst
7780

7881
2.1
79-
===
82+
***
8083
.. toctree::
8184
:maxdepth: 1
8285

@@ -86,7 +89,7 @@ Release notes
8689
../api/prev_api_changes/api_changes_2.1.0.rst
8790

8891
2.0
89-
===
92+
***
9093
.. toctree::
9194
:maxdepth: 1
9295

@@ -95,7 +98,7 @@ Release notes
9598
../api/prev_api_changes/api_changes_2.0.0.rst
9699

97100
1.5
98-
===
101+
***
99102
.. toctree::
100103
:maxdepth: 1
101104

@@ -104,7 +107,7 @@ Release notes
104107
../api/prev_api_changes/api_changes_1.5.2.rst
105108

106109
1.4
107-
===
110+
***
108111
.. toctree::
109112
:maxdepth: 1
110113

@@ -113,15 +116,15 @@ Release notes
113116
../api/prev_api_changes/api_changes_1.5.0.rst
114117

115118
1.3
116-
===
119+
***
117120
.. toctree::
118121
:maxdepth: 1
119122

120123
prev_whats_new/whats_new_1.3.rst
121124
../api/prev_api_changes/api_changes_1.3.x.rst
122125

123126
1.2
124-
===
127+
***
125128
.. toctree::
126129
:maxdepth: 1
127130

@@ -130,22 +133,22 @@ Release notes
130133
../api/prev_api_changes/api_changes_1.2.x.rst
131134

132135
1.1
133-
===
136+
***
134137
.. toctree::
135138
:maxdepth: 1
136139

137140
prev_whats_new/whats_new_1.1.rst
138141
../api/prev_api_changes/api_changes_1.1.x.rst
139142

140143
1.0
141-
===
144+
***
142145
.. toctree::
143146
:maxdepth: 1
144147

145148
prev_whats_new/whats_new_1.0.rst
146149

147150
0.x
148-
===
151+
***
149152
.. toctree::
150153
:maxdepth: 1
151154

0 commit comments

Comments
 (0)
0