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

Skip to content

Commit e2fcd51

Browse files
anntzeranntzer
committed
Fix more missing references again.
1 parent bdcd9fc commit e2fcd51

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+256
-741
lines changed

‎doc/api/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,7 @@ Matplotlib consists of the following submodules:
121121
table_api.rst
122122
testing_api.rst
123123
text_api.rst
124+
texmanager_api.rst
124125
textpath_api.rst
125126
ticker_api.rst
126127
tight_layout_api.rst

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -61,15 +61,15 @@ This new default may be overridden in either of three ways:
6161
3. Manually specify a list of artists in the new kwarg ``bbox_extra_artists``.
6262

6363

64-
`Text.set_text` with string argument ``None`` sets string to empty
65-
------------------------------------------------------------------
64+
`.Text.set_text` with string argument ``None`` sets string to empty
65+
-------------------------------------------------------------------
6666

67-
`Text.set_text` when passed a string value of ``None`` would set the
67+
`.Text.set_text` when passed a string value of ``None`` would set the
6868
string to ``"None"``, so subsequent calls to `.Text.get_text` would return
6969
the ambiguous ``"None"`` string.
7070

7171
This change sets text objects passed ``None`` to have empty strings, so that
72-
`Text.get_text` returns an empty string.
72+
`.Text.get_text` returns an empty string.
7373

7474

7575

@@ -160,7 +160,7 @@ filter that existed before the test started using ``warnings.catch_warnings``.
160160
Non-interactive FigureManager classes are now aliases of FigureManagerBase
161161
--------------------------------------------------------------------------
162162

163-
The `FigureManagerPdf`, `FigureManagerPS`, and `FigureManagerSVG` classes,
163+
The ``FigureManagerPdf``, ``FigureManagerPS``, and ``FigureManagerSVG`` classes,
164164
which were previously empty subclasses of `.FigureManagerBase` (i.e., not
165165
adding or overriding any attribute or method), are now direct aliases for
166166
`.FigureManagerBase`.
@@ -213,7 +213,7 @@ Streamplot last row and column fixed
213213
------------------------------------
214214

215215
A bug was fixed where the last row and column of data in
216-
`~.Axes.axes.streamplot` were being dropped.
216+
`~.Axes.streamplot` were being dropped.
217217

218218

219219
Changed default `.AutoDateLocator` kwarg *interval_multiples* to ``True``
@@ -303,11 +303,11 @@ being incorrectly modified by these functions.
303303

304304

305305

306-
`CallbackRegistry` now stores callbacks using stdlib's `.WeakMethod`\s
307-
----------------------------------------------------------------------
306+
`.CallbackRegistry` now stores callbacks using stdlib's `weakref.WeakMethod`\s
307+
------------------------------------------------------------------------------
308308

309309
In particular, this implies that ``CallbackRegistry.callbacks[signal]`` is now
310-
a mapping of callback ids to `.WeakMethod`\s (i.e., they need to be first called
310+
a mapping of callback ids to `weakref.WeakMethod`\s (i.e., they need to be first called
311311
with no arguments to retrieve the method itself).
312312

313313

@@ -447,7 +447,7 @@ marker styles
447447
Deprecation of ``LocatableAxes`` in toolkits
448448
````````````````````````````````````````````
449449

450-
The ``LocatableAxes`` classes in toolkits have been deprecated. The base `Axes`
450+
The ``LocatableAxes`` classes in toolkits have been deprecated. The base `~.axes.Axes`
451451
classes provide the same functionality to all subclasses, thus these mixins are
452452
no longer necessary. Related functions have also been deprecated. Specifically:
453453

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -270,10 +270,10 @@ allows using it as a decorator.
270270

271271
The new API is modelled after `atexit.register` / `atexit.unregister`.
272272

273-
`~.collections.StemContainer` performance increase
274-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
273+
`~.container.StemContainer` performance increase
274+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
275275

276-
`~.collections.StemContainer` objects can now store a
276+
`~.container.StemContainer` objects can now store a
277277
`~.collections.LineCollection` object instead of a list of
278278
`~.lines.Line2D` objects for stem lines plotted using
279279
`~.Axes.stem`. This gives a very large performance boost to displaying
@@ -795,7 +795,7 @@ Changes in parameter names
795795
This will only affect cases where that parameter has been set
796796
as a keyword argument. The common usage pattern as a positional argument
797797
``matplotlib.use('Qt5Agg')`` is not affected.
798-
- The *normed* parameter to `Axes.hist2d` has been renamed to *density*.
798+
- The *normed* parameter to `.Axes.hist2d` has been renamed to *density*.
799799
- The *s* parameter to `.Annotation` (and indirectly `Axes.annotation`) has
800800
been renamed to *text*.
801801
- The *tolerence* parameter to
@@ -952,9 +952,9 @@ picked up by the `matplotlib.testing.conftest.mpl_test_settings` fixture.
952952
Quiver
953953
~~~~~~
954954

955-
- ``.color`` attribute of `Quiver` objects
955+
- ``.color`` attribute of `.Quiver` objects
956956

957-
Instead, use (as for any `Collection`) the ``get_facecolor`` method.
957+
Instead, use (as for any `.Collection`) the ``get_facecolor`` method.
958958
Note that setting to the ``.color`` attribute did not update the quiver artist,
959959
whereas calling ``set_facecolor`` does.
960960

@@ -999,7 +999,7 @@ Transforms / scales
999999
- ``InvertedNaturalLogTransform``
10001000

10011001
These classes defined in :mod:`matplotlib.scale` are deprecated.
1002-
As a replacement, use the general `LogTransform` and `InvertedLogTransform`
1002+
As a replacement, use the general `~.scale.LogTransform` and `~.scale.InvertedLogTransform`
10031003
classes, whose constructors take a *base* argument.
10041004

10051005
Locators / Formatters
@@ -1086,8 +1086,8 @@ The following API elements have bee un-deprecated:
10861086
New features
10871087
------------
10881088

1089-
`Text` now has a ``c`` alias for the ``color`` property
1090-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1089+
`.Text` now has a ``c`` alias for the ``color`` property
1090+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10911091
For consistency with `.Line2D`, the `~.text.Text` class has gained the ``c``
10921092
alias for the ``color`` property. For example, one can now write ::
10931093

‎doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,12 +62,12 @@ Matplotlib used to recompute autoscaled limits after every plotting
6262
rendering the canvas, or when the user queries the Axes limits. This is a
6363
major performance improvement for plots with a large number of artists.
6464

65-
In particular, this means that artists added manually with `Axes.add_line`,
66-
`Axes.add_patch`, etc. will be taken into account by the autoscale, even
67-
without an explicit call to `Axes.autoscale_view`.
65+
In particular, this means that artists added manually with `.Axes.add_line`,
66+
`.Axes.add_patch`, etc. will be taken into account by the autoscale, even
67+
without an explicit call to `.Axes.autoscale_view`.
6868

6969
In some cases, this can result in different limits being reported. If this is
70-
an issue, consider triggering a draw with `fig.canvas.draw`.
70+
an issue, consider triggering a draw with ``fig.canvas.draw()``.
7171

7272
Autoscaling has also changed for artists that are based on the `.Collection`
7373
class. Previously, the method that calculates the automatic limits
@@ -230,7 +230,7 @@ performance penalty. Anti-aliasing can be improved with other filters.
230230

231231
rcParams
232232
~~~~~~~~
233-
When using `RendererSVG` with ``rcParams["svg.image_inline"] ==
233+
When using `.RendererSVG` with ``rcParams["svg.image_inline"] ==
234234
True``, externally written images now use a single counter even if the
235235
``renderer.basename`` attribute is overwritten, rather than a counter per
236236
basename.

‎doc/api/prev_api_changes/api_changes_3.2.0/deprecations.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ the resulting data.
1717
axes and axis
1818
~~~~~~~~~~~~~
1919
Setting ``Axis.major.locator``, ``Axis.minor.locator``, ``Axis.major.formatter``
20-
or ``Axis.minor.formatter`` to an object that is not a subclass of `Locator` or
21-
`Formatter` (respectively) is deprecated. Note that these attributes should
20+
or ``Axis.minor.formatter`` to an object that is not a subclass of `.Locator` or
21+
`.Formatter` (respectively) is deprecated. Note that these attributes should
2222
usually be set using `Axis.set_major_locator`, `Axis.set_minor_locator`, etc.
2323
which already raise an exception when an object of the wrong class is passed.
2424

@@ -113,8 +113,8 @@ Deprecation of the constructor means that classes inheriting from
113113

114114
Locators
115115
~~~~~~~~
116-
The unused `Locator.autoscale()` method is deprecated (pass the axis limits to
117-
`Locator.view_limits()` instead).
116+
The unused `.Locator.autoscale` method is deprecated (pass the axis limits to
117+
`.Locator.view_limits` instead).
118118

119119
Animation
120120
~~~~~~~~~
@@ -232,7 +232,7 @@ deprecated. Use an explicit list instead.
232232
Scales
233233
~~~~~~
234234
Passing unsupported keyword arguments to `.ScaleBase` and its subclasses
235-
`.LinearScale`, and `.SymLogScale` is deprecated and will raise a `TypeError` in 3.3.
235+
`.LinearScale`, and `.SymmetricalLogScale` is deprecated and will raise a `TypeError` in 3.3.
236236

237237
If extra kwargs are passed to `.LogScale`, `TypeError` will now be
238238
raised instead of `ValueError`.

‎doc/api/texmanager_api.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
*************************
2+
``matplotlib.texmanager``
3+
*************************
4+
5+
.. automodule:: matplotlib.texmanager
6+
:members:
7+
:undoc-members:
8+
:show-inheritance:

‎doc/api/toolkits/mplot3d.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,9 @@ mplot3d API
1111
:no-members:
1212
:no-undoc-members:
1313

14-
14+
.. module:: mpl_toolkits.mplot3d.axes3d
1515
.. currentmodule:: mpl_toolkits.mplot3d
1616

17-
.. _toolkit_mplot3d-axesapi:
18-
1917
:mod:`~mpl_toolkits.mplot3d.axes3d`
2018
===================================
2119

@@ -32,7 +30,8 @@ mplot3d API
3230
axes3d.Axes3D
3331

3432

35-
.. _toolkit_mplot3d-axisapi:
33+
.. module:: mpl_toolkits.mplot3d.axis3d
34+
.. currentmodule:: mpl_toolkits.mplot3d
3635

3736
:mod:`~mpl_toolkits.mplot3d.axis3d`
3837
===================================
@@ -53,7 +52,8 @@ mplot3d API
5352
axis3d.Axis
5453

5554

56-
.. _toolkit_mplot3d-artapi:
55+
.. module:: mpl_toolkits.mplot3d.art3d
56+
.. currentmodule:: mpl_toolkits.mplot3d
5757

5858
:mod:`~mpl_toolkits.mplot3d.art3d`
5959
==================================
@@ -90,7 +90,8 @@ Art3D Utility Functions
9090
art3d.rotate_axes
9191
art3d.text_2d_to_3d
9292

93-
.. _toolkit_mplot3d-projapi:
93+
.. module:: mpl_toolkits.mplot3d.proj3d
94+
.. currentmodule:: mpl_toolkits.mplot3d
9495

9596
:mod:`~mpl_toolkits.mplot3d.proj3d`
9697
===================================

‎doc/api/toolkits/mplot3d/faq.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,6 @@ Historically, mplot3d has suffered from a hard-coding of parameters used
4747
to control visuals such as label spacing, tick length, and grid line width.
4848
Work is being done to eliminate this issue. For matplotlib v1.1.0, there is
4949
a semi-official manner to modify these parameters. See the note in the
50-
:ref:`toolkit_mplot3d-axisapi` section of the mplot3d API documentation for
50+
:mod:`.mplot3d.axis3d` section of the mplot3d API documentation for
5151
more information.
5252

‎doc/conf.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,12 +109,13 @@ def _check_dependencies():
109109

110110
intersphinx_mapping = {
111111
'python': ('https://docs.python.org/3', None),
112+
'cycler': ('https://matplotlib.org/cycler', None),
113+
'dateutil': ('https://dateutil.readthedocs.io/en/stable/', None),
112114
'numpy': ('https://docs.scipy.org/doc/numpy/', None),
113-
'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None),
114115
'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None),
115116
'Pillow': ('https://pillow.readthedocs.io/en/stable/', None),
116-
'cycler': ('https://matplotlib.org/cycler', None),
117-
'dateutil': ('https://dateutil.readthedocs.io/en/stable/', None),
117+
'pytest': ('https://pytest.org/en/stable', None),
118+
'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None),
118119
}
119120

120121

‎doc/devel/MEP/MEP10.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ autosummary extension
119119

120120
The Sphinx autosummary extension should be used to generate summary
121121
tables, that link to separate pages of documentation. Some classes
122-
that have many methods (e.g. `Axes.axes`) should be documented with
122+
that have many methods (e.g. `~.axes.Axes`) should be documented with
123123
one method per page, whereas smaller classes should have all of their
124124
methods together.
125125

‎doc/devel/MEP/MEP14.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ requires the installation of TeX-specific font packages, for example,
115115
and can not use TrueType fonts directly. Unfortunately, despite the
116116
different semantics for font selection, the same set of font
117117
properties are used for each. This is true of both the
118-
`FontProperties` class and the font-related `rcParams` (which
118+
`.FontProperties` class and the font-related `.rcParams` (which
119119
basically share the same code underneath). Instead, we should define
120120
a core set of font selection parameters that will work across all text
121121
engines, and have engine-specific configuration to allow the user to
@@ -202,9 +202,11 @@ possible.
202202

203203
Alternative font subsetting options include using the subsetting
204204
built-in to Cairo (not clear if it can be used without the rest of
205-
Cairo), or using `fontforge` (which is a heavy and not terribly
205+
Cairo), or using fontforge_ (which is a heavy and not terribly
206206
cross-platform dependency).
207207

208+
.. _fontforge: https://fontforge.org
209+
208210
**Freetype wrappers**
209211

210212
Our FreeType wrapper could really use a reworking. It defines its own
@@ -254,7 +256,7 @@ arbitrary text engine in another should be possible.
254256
The text mode is currently set by a global rcParam ("text.usetex") so
255257
it's either all on or all off. We should continue to have a global
256258
rcParam to choose the text engine ("text.layout_engine"), but it
257-
should under the hood be an overridable property on the `Text` object,
259+
should under the hood be an overridable property on the `.Text` object,
258260
so the same figure can combine the results of multiple text layout
259261
engines if necessary.
260262

‎doc/devel/MEP/MEP15.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@ None so far.
1818
Abstract
1919
========
2020

21-
When one axis of a 2-dimensional plot if overridden via `xlim` or `ylim`,
21+
When one axis of a 2-dimensional plot if overridden via `~.Axes.set_xlim` or `~.Axes.set_ylim`,
2222
automatic scaling of the remaining axis should be based on the data that falls
2323
within the specified limits of the first axis.
2424

2525
Detailed description
2626
====================
2727

28-
When axis limits for a 2-D plot are specified for one axis only (via `xlim` or
29-
`ylim`), matplotlib currently does not currently rescale the other axis. The
28+
When axis limits for a 2-D plot are specified for one axis only (via `~.Axes.set_xlim` or
29+
`~.Axes.set_ylim`), matplotlib currently does not currently rescale the other axis. The
3030
result is that the displayed curves or symbols may be compressed into a tiny
3131
portion of the available area, so that the final plot conveys much less
3232
information than it would with appropriate axis scaling.

‎doc/devel/MEP/MEP22.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ ToolBase(object)
7777

7878
Tools can have a graphical representation as the `SubplotTool` or not even be present in the Toolbar as `Quit`
7979

80-
The `ToolBase` has the following class attributes for configuration at definition time
80+
The `.ToolBase` has the following class attributes for configuration at definition time
8181

8282
* keymap = None: Key(s) to be used to trigger the tool
8383
* description = '': Small description of the tool
@@ -113,7 +113,7 @@ The following instance attributes are set at instantiation:
113113
ToolToggleBase(ToolBase)
114114
------------------------
115115

116-
The `ToolToggleBase` has the following class attributes for
116+
The `.ToolToggleBase` has the following class attributes for
117117
configuration at definition time
118118

119119
* radio_group = None: Attribute to group 'radio' like tools (mutually
@@ -124,7 +124,7 @@ The **Toggleable** Tools, can capture keypress, mouse moves, and mouse
124124
button press
125125

126126
It defines the following methods
127-
* enable(self, event): Called by `ToolToggleBase.trigger` method
127+
* enable(self, event): Called by `.ToolToggleBase.trigger` method
128128
* disable(self, event): Called when the tool is untoggled
129129
* toggled : **Property** True or False
130130

‎doc/devel/coding_guide.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -164,9 +164,11 @@ Automated tests
164164

165165
- Whenever a pull request is created or updated, Travis and Appveyor
166166
automatically runs the test suite on all versions of Python
167-
supported by Matplotlib. The `tox` support in Matplotlib may be
167+
supported by Matplotlib. The tox_ support in Matplotlib may be
168168
useful for testing locally.
169169

170+
.. _tox: https://tox.readthedocs.io/
171+
170172
* Do not self merge, except for 'small' patches to un-break the CI or
171173
when another reviewer explicitly allows it (ex, "Approve modulo CI
172174
passing, may self merge when green").
@@ -316,4 +318,4 @@ and then continue the cherry pick::
316318
git cherry-pick --continue
317319

318320
Use your discretion to push directly to upstream or to open a PR; be
319-
sure to push or PR against the `v2.2.x` upstream branch, not `master`!
321+
sure to push or PR against the ``v2.2.x`` upstream branch, not ``master``!

‎doc/devel/contributing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -444,7 +444,7 @@ To include `logging` in your module, at the top of the module, you need to
444444
will log to a logger named ``matplotlib.yourmodulename``.
445445

446446
If an end-user of Matplotlib sets up `logging` to display at levels
447-
more verbose than `logger.WARNING` in their code with the Matplotlib-provided
447+
more verbose than `logging.WARNING` in their code with the Matplotlib-provided
448448
helper::
449449

450450
plt.set_loglevel("debug")

‎doc/devel/testing.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Running the tests is simple. Make sure you have pytest installed and run::
4646

4747
in the root directory of the repository.
4848

49-
`pytest` can be configured via a lot of `commandline parameters`_. Some
49+
pytest can be configured via a lot of `commandline parameters`_. Some
5050
particularly useful ones are:
5151

5252
============================= ===========
@@ -160,7 +160,7 @@ the tests, they should now pass.
160160
Baseline images take a lot of space in the Matplotlib repository.
161161
An alternative approach for image comparison tests is to use the
162162
`~matplotlib.testing.decorators.check_figures_equal` decorator, which should be
163-
used to decorate a function taking two `Figure` parameters and draws the same
163+
used to decorate a function taking two `.Figure` parameters and draws the same
164164
images on the figures using two different methods (the tested method and the
165165
baseline method). The decorator will arrange for setting up the figures and
166166
then collect the drawn results and compare them.

0 commit comments

Comments
 (0)