8000 Merge pull request #22102 from jklymak/doc-usage-guide · matplotlib/matplotlib@a8edff6 · GitHub
[go: up one dir, main page]
Skip to content

Commit a8edff6

Browse files
jklymakjklymak
authored
Merge pull request #22102 from jklymak/doc-usage-guide
DOC: rename usage tutorial to quick_start
2 parents 2465eff + 2f65eca commit a8edff6

File tree

7 files changed

+17
-13
lines changed

7 files changed

+17
-13
lines changed

‎.flake8

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ per-file-ignores =
100100
tutorials/introductory/images.py: E402, E501
101101
tutorials/introductory/pyplot.py: E402, E501
102102
tutorials/introductory/sample_plots.py: E501
103-
tutorials/introductory/usage.py: E703
103+
tutorials/introductory/quick_start.py: E703
104104
tutorials/text/annotations.py: E402, E501
105105
tutorials/text/text_intro.py: E402
106106
tutorials/text/text_props.py: E501

‎doc/devel/documenting_mpl.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -199,15 +199,15 @@ Documents can be linked with the ``:doc:`` directive:
199199
200200
See the :doc:`/users/installing/index`
201201
202-
See the tutorial :doc:`/tutorials/introductory/usage`
202+
See the tutorial :doc:`/tutorials/introductory/quick_start`
203203
204204
See the example :doc:`/gallery/lines_bars_and_markers/simple_plot`
205205
206206
will render as:
207207

208208
See the :doc:`/users/installing/index`
209209

210-
See the tutorial :doc:`/tutorials/introductory/usage`
210+
See the tutorial :doc:`/tutorials/introductory/quick_start`
211211

212212
See the example :doc:`/gallery/lines_bars_and_markers/simple_plot`
213213

@@ -847,7 +847,7 @@ render as comments in :doc:`/gallery/lines_bars_and_markers/simple_plot`.
847847

848848
Tutorials are made with the exact same mechanism, except they are longer, and
849849
typically have more than one comment block (i.e.
850-
:doc:`/tutorials/introductory/usage`). The first comment block
850+
:doc:`/tutorials/introductory/quick_start`). The first comment block
851851
can be the same as the example above. Subsequent blocks of ReST text
852852
are delimited by a line of ``###`` characters:
853853

‎doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Learning resources
4646
Tutorials
4747
^^^^^^^^^
4848

49-
- :doc:`Quick-start guide <tutorials/introductory/usage>`
49+
- :doc:`Quick-start guide <tutorials/introductory/quick_start>`
5050
- :doc:`Plot types <plot_types/index>`
5151
- `Introductory tutorials <../tutorials/index.html#introductory>`_
5252
- :doc:`External learning resources <users/resources/index>`

‎doc/users/getting_started/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,12 @@ Here is a minimal example plot:
4444
ax.plot(x, y)
4545
plt.show()
4646

47-
If a plot does not show up please check :ref:`troubleshooting-faq`.
47+
If a plot does not show up please check :ref:`troubleshooting-faq`.
4848

4949
Where to go next
5050
----------------
5151

5252
- Check out :doc:`Plot types </plot_types/index>` to get an overview of the
5353
types of plots you can create with Matplotlib.
5454
- Learn Matplotlib from the ground up in the
55-
:doc:`Quick-start guide </tutorials/introductory/usage>`.
55+
:doc:`Quick-start guide </tutorials/introductory/quick_start>`.

‎tutorials/introductory/images.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@
4343
settings. The alternative is the object-oriented interface, which is also
4444
very powerful, and generally more suitable for large application
4545
development. If you'd like to learn about the object-oriented
46-
interface, a great place to start is our :doc:`Usage guide
47-
</tutorials/introductory/usage>`. For now, let's get on
46+
interface, a great place to start is our :doc:`Quick start guide
47+
</tutorials/introductory/quick_start>`. For now, let's get on
4848
with the imperative-style approach:
4949
"""
5050

‎tutorials/introductory/pyplot.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
Pyplot tutorial
44
===============
55
6-
An introduction to the pyplot interface.
6+
An introduction to the pyplot interface. Please also see
7+
:doc:`/tutorials/introductory/quick_start` for an overview of how Matplotlib works.
78
"""
89

910
###############################################################################

‎tutorials/introductory/usage.py renamed to ‎tutorials/introductory/quick_start.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
"""
2-
***********
3-
Basic Usage
4-
***********
2+
*****************
3+
Quick start guide
4+
*****************
55
66
This tutorial covers some basic usage patterns and best practices to
77
help you get started with Matplotlib.
8+
9+
.. redirect-from:: /tutorials/introductory/usage
10+
811
"""
912

1013
# sphinx_gallery_thumbnail_number = 3

0 commit comments

Comments
 (0)
0