Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit7eb99af

Browse files
committed
DOC: more site re-org
The root of the index is users/indexMost material is now under users/
1 parent66687d0 commit7eb99af

16 files changed

+58
-63
lines changed

‎doc/_templates/mpl_nav_bar.html

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,12 @@
1010
<aclass="reference internal nav-link"href="{{ pathto('tutorials/index') }}">Tutorials</a>
1111
</li>
1212
<liclass="nav-item">
13-
<aclass="reference internal nav-link"href="{{ pathto('api/index') }}">Reference</a>
13+
<aclass="reference internal nav-link"href="{{ pathto('api/index') }}">APIReference</a>
1414
</li>
1515
<liclass="nav-item">
16-
<aclass="reference internal nav-link"href="{{ pathto('users/index') }}">Usage guide</a>
16+
<aclass="reference internal nav-link"href="{{ pathto('users/index') }}">Users guide</a>
1717
</li>
1818
<liclass="nav-item">
19-
<aclass="reference internal nav-link"href="{{ pathto('devel/index') }}">Develop</a>
20-
</li>
21-
<liclass="nav-item">
22-
<aclass="reference internal nav-link"href="{{ pathto('users/release_notes') }}">Release notes</a>
19+
<aclass="reference internal nav-link"href="{{ pathto('devel/index') }}">Contributing</a>
2320
</li>
2421
</ul>

‎doc/api/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Reference
2-
=========
1+
APIReference
2+
=============
33

44
When using the library you will typically create
55
:doc:`Figure<figure_api>` and:doc:`Axes<axes_api>` objects and

‎doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ def _check_dependencies():
213213
source_encoding="utf-8"
214214

215215
# The master toctree document.
216-
master_doc='contents'
216+
master_doc='users/index'
217217

218218
# General substitutions.
219219
try:

‎doc/contents.rst

Lines changed: 0 additions & 25 deletions
This file was deleted.

‎doc/index.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Learning resources
5353
-:doc:`Quick-start guide<tutorials/introductory/usage>`
5454
-:doc:`Plot types<plot_types/index>`
5555
- `Introductory tutorials<../tutorials/index.html#introductory>`_
56-
-:doc:`External learning resources<resources/index>`
56+
-:doc:`External learning resources<users/resources/index>`
5757

5858
---
5959

@@ -67,7 +67,7 @@ Learning resources
6767
Understand how Matplotlib works
6868
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6969

70-
- The:ref:`users-guide-explain` in the:doc:`Usage guide<users/index>`
70+
- The:ref:`users-guide-explain` in the:doc:`Users guide<users/index>`
7171
- Many of the:ref:`Intermediate<tutorials-intermediate>` and
7272
:ref:`Advanced<tutorials-advanced>` tutorials
7373
have explanatory material
@@ -106,7 +106,7 @@ you can help!
106106
- or improve the:ref:`documentation and code<developers-guide-index>`
107107

108108

109-
Site map
110-
--------
109+
Users guide
110+
-----------
111111

112-
The:ref:`completecontents of the docs<complete_sitemap>`.
112+
The`contents of the docs<users/index.html>`_.

‎doc/users/backmatter.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ Project information
66
:maxdepth:1
77

88
license.rst
9-
../citing.rst
9+
citing.rst
1010
credits.rst
1111
history.rst

‎doc/citing.rstrenamed to‎doc/users/citing.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
:orphan:
1+
..redirect-from::/citing
2+
23

34
Citing Matplotlib
45
=================

‎doc/faq/environment_variables_faq.rstrenamed to‎doc/users/faq/environment_variables_faq.rst

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

3+
..redirect-from::/faq/environment_variables_faq
4+
35
*********************
46
Environment variables
57
*********************

‎doc/faq/howto_faq.rstrenamed to‎doc/users/faq/howto_faq.rst

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

3+
..redirect-from::/faq/howto_faq
4+
35
******
46
How-to
57
******

‎doc/faq/index.rstrenamed to‎doc/users/faq/index.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
.. _faq-index:
22

3-
######
4-
How-to
5-
######
3+
..redirect-from::/faq/index
4+
5+
##########################
6+
How-to and troubleshooting
7+
##########################
68

79
..only::html
810

‎doc/faq/installing_faq.rstrenamed to‎doc/users/faq/installing_faq.rst

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

3+
..redirect-from::/faq/installing_faq
4+
35
**************
46
Installing FAQ
57
**************

‎doc/faq/troubleshooting_faq.rstrenamed to‎doc/users/faq/troubleshooting_faq.rst

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

3+
..redirect-from::/faq/troubleshooting_faq
4+
35
***************
46
Troubleshooting
57
***************

‎doc/users/index.rst

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,23 @@
11
.. _users-guide-index:
22

3+
..redirect-from::/contents
4+
5+
36
###########
4-
Usage guide
7+
Users guide
58
###########
69

710
..toctree::
811
:maxdepth:2
912

13+
installing.rst
1014
../plot_types/index.rst
1115
../tutorials/index.rst
1216
../gallery/index.rst
1317
explain.rst
14-
../faq/index.rst
18+
faq/index.rst
1519
../api/index.rst
16-
../resources/index.rst
20+
resources/index.rst
21+
../devel/index.rst
22+
backmatter.rst
23+
release_notes.rst

‎doc/users/release_notes.rst

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,11 @@ Version 3.4
2828
prev_whats_new/github_stats_3.4.1.rst
2929
prev_whats_new/github_stats_3.4.0.rst
3030

31+
Past versions
32+
=============
33+
3134
Version 3.3
32-
===========
35+
~~~~~~~~~~~
3336
..toctree::
3437
:maxdepth:1
3538

@@ -43,7 +46,7 @@ Version 3.3
4346
prev_whats_new/github_stats_3.3.0.rst
4447

4548
Version 3.2
46-
===========
49+
~~~~~~~~~~~
4750
..toctree::
4851
:maxdepth:1
4952

@@ -54,7 +57,7 @@ Version 3.2
5457
prev_whats_new/github_stats_3.2.0.rst
5558

5659
Version 3.1
57-
===========
60+
~~~~~~~~~~~
5861
..toctree::
5962
:maxdepth:1
6063

@@ -67,7 +70,7 @@ Version 3.1
6770
prev_whats_new/github_stats_3.1.0.rst
6871

6972
Version 3.0
70-
===========
73+
~~~~~~~~~~~
7174
..toctree::
7275
:maxdepth:1
7376

@@ -80,15 +83,15 @@ Version 3.0
8083
prev_whats_new/github_stats_3.0.0.rst
8184

8285
Version 2.2
83-
===========
86+
~~~~~~~~~~~
8487
..toctree::
8588
:maxdepth:1
8689

8790
prev_whats_new/whats_new_2.2.rst
8891
../api/prev_api_changes/api_changes_2.2.0.rst
8992

9093
Version 2.1
91-
===========
94+
~~~~~~~~~~~
9295
..toctree::
9396
:maxdepth:1
9497

@@ -98,7 +101,7 @@ Version 2.1
98101
../api/prev_api_changes/api_changes_2.1.0.rst
99102

100103
Version 2.0
101-
===========
104+
~~~~~~~~~~~
102105
..toctree::
103106
:maxdepth:1
104107

@@ -107,7 +110,7 @@ Version 2.0
107110
../api/prev_api_changes/api_changes_2.0.0.rst
108111

109112
Version 1.5
110-
===========
113+
~~~~~~~~~~~
111114
..toctree::
112115
:maxdepth:1
113116

@@ -117,23 +120,23 @@ Version 1.5
117120
../api/prev_api_changes/api_changes_1.5.0.rst
118121

119122
Version 1.4
120-
===========
123+
~~~~~~~~~~~
121124
..toctree::
122125
:maxdepth:1
123126

124127
prev_whats_new/whats_new_1.4.rst
125128
../api/prev_api_changes/api_changes_1.4.x.rst
126129

127130
Version 1.3
128-
===========
131+
~~~~~~~~~~~
129132
..toctree::
130133
:maxdepth:1
131134

132135
prev_whats_new/whats_new_1.3.rst
133136
../api/prev_api_changes/api_changes_1.3.x.rst
134137

135138
Version 1.2
136-
===========
139+
~~~~~~~~~~~
137140
..toctree::
138141
:maxdepth:1
139142

@@ -142,22 +145,22 @@ Version 1.2
142145
../api/prev_api_changes/api_changes_1.2.x.rst
143146

144147
Version 1.1
145-
===========
148+
~~~~~~~~~~~
146149
..toctree::
147150
:maxdepth:1
148151

149152
prev_whats_new/whats_new_1.1.rst
150153
../api/prev_api_changes/api_changes_1.1.x.rst
151154

152155
Version 1.0
153-
===========
156+
~~~~~~~~~~~
154157
..toctree::
155158
:maxdepth:1
156159

157160
prev_whats_new/whats_new_1.0.rst
158161

159162
Version 0.x
160-
===========
163+
~~~~~~~~~~~
161164
..toctree::
162165
:maxdepth:1
163166

‎doc/resources/index.rstrenamed to‎doc/users/resources/index.rst

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

3+
..redirect-from::/resources/index
4+
35
******************
46
External resources
57
******************

‎examples/README.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ This page contains example plots. Click on any image to see the full image
1010
and source code.
1111

1212
For longer tutorials, see our `tutorials page <../tutorials/index.html>`_.
13-
You can also find `external resources <../resources/index.html>`_ and
14-
a `FAQ <../faq/index.html>`_ in our `user guide <../contents.html>`_.
13+
You can also find `external resources <../users/resources/index.html>`_ and
14+
a `FAQ <../users/faq/index.html>`_ in our `user guide <../users/index.html>`_.

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp