matplotlib · anntzer · Jan 9, 2020 · Jan 6, 2020
diff --git a/doc/api/index.rst b/doc/api/index.rst
@@ -121,6 +121,7 @@ Matplotlib consists of the following submodules:
    table_api.rst
    testing_api.rst
    text_api.rst
+   texmanager_api.rst
    textpath_api.rst
    ticker_api.rst
    tight_layout_api.rst

diff --git a/doc/api/prev_api_changes/api_changes_3.0.0.rst b/doc/api/prev_api_changes/api_changes_3.0.0.rst
@@ -61,15 +61,15 @@ This new default may be overridden in either of three ways:
 3. Manually specify a list of artists in the new kwarg ``bbox_extra_artists``.
 
 
-`Text.set_text` with string argument ``None`` sets string to empty
-------------------------------------------------------------------
+`.Text.set_text` with string argument ``None`` sets string to empty
+-------------------------------------------------------------------
 
-`Text.set_text` when passed a string value of ``None`` would set the
+`.Text.set_text` when passed a string value of ``None`` would set the
 string to ``"None"``, so subsequent calls to `.Text.get_text` would return
 the ambiguous ``"None"`` string.
 
 This change sets text objects passed ``None`` to have empty strings, so that
-`Text.get_text` returns an empty string.
+`.Text.get_text` returns an empty string.
 
 
 
@@ -160,7 +160,7 @@ filter that existed before the test started using ``warnings.catch_warnings``.
 Non-interactive FigureManager classes are now aliases of FigureManagerBase
 --------------------------------------------------------------------------
 
-The `FigureManagerPdf`, `FigureManagerPS`, and `FigureManagerSVG` classes,
+The ``FigureManagerPdf``, ``FigureManagerPS``, and ``FigureManagerSVG`` classes,
 which were previously empty subclasses of `.FigureManagerBase` (i.e., not
 adding or overriding any attribute or method), are now direct aliases for
 `.FigureManagerBase`.
@@ -213,7 +213,7 @@ Streamplot last row and column fixed
 ------------------------------------
 
 A bug was fixed where the last row and column of data in
-`~.Axes.axes.streamplot` were being dropped.
+`~.Axes.streamplot` were being dropped.
 
 
 Changed default `.AutoDateLocator` kwarg *interval_multiples* to ``True``
@@ -303,11 +303,11 @@ being incorrectly modified by these functions.
 
 
 
-`CallbackRegistry` now stores callbacks using stdlib's `.WeakMethod`\s
-----------------------------------------------------------------------
+`.CallbackRegistry` now stores callbacks using stdlib's `weakref.WeakMethod`\s
+------------------------------------------------------------------------------
 
 In particular, this implies that ``CallbackRegistry.callbacks[signal]`` is now
-a mapping of callback ids to `.WeakMethod`\s (i.e., they need to be first called
+a mapping of callback ids to `weakref.WeakMethod`\s (i.e., they need to be first called
 with no arguments to retrieve the method itself).
 
 
@@ -447,7 +447,7 @@ marker styles
 Deprecation of ``LocatableAxes`` in toolkits
 ````````````````````````````````````````````
 
-The ``LocatableAxes`` classes in toolkits have been deprecated. The base `Axes`
+The ``LocatableAxes`` classes in toolkits have been deprecated. The base `~.axes.Axes`
 classes provide the same functionality to all subclasses, thus these mixins are
 no longer necessary. Related functions have also been deprecated. Specifically:
 

diff --git a/doc/api/prev_api_changes/api_changes_3.1.0.rst b/doc/api/prev_api_changes/api_changes_3.1.0.rst
@@ -270,10 +270,10 @@ allows using it as a decorator.
 
 The new API is modelled after `atexit.register` / `atexit.unregister`.
 
-`~.collections.StemContainer` performance increase
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+`~.container.StemContainer` performance increase
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-`~.collections.StemContainer` objects can now store a
+`~.container.StemContainer` objects can now store a
 `~.collections.LineCollection` object instead of a list of
 `~.lines.Line2D` objects for stem lines plotted using
 `~.Axes.stem`. This gives a very large performance boost to displaying
@@ -795,7 +795,7 @@ Changes in parameter names
   This will only affect cases where that parameter has been set
   as a keyword argument. The common usage pattern as a positional argument
   ``matplotlib.use('Qt5Agg')`` is not affected.
-- The *normed* parameter to `Axes.hist2d` has been renamed to *density*.
+- The *normed* parameter to `.Axes.hist2d` has been renamed to *density*.
 - The *s* parameter to `.Annotation` (and indirectly `Axes.annotation`) has
   been renamed to *text*.
 - The *tolerence* parameter to
@@ -952,9 +952,9 @@ picked up by the `matplotlib.testing.conftest.mpl_test_settings` fixture.
 Quiver
 ~~~~~~
 
-- ``.color`` attribute of `Quiver` objects
+- ``.color`` attribute of `.Quiver` objects
 
-Instead, use (as for any `Collection`) the ``get_facecolor`` method.
+Instead, use (as for any `.Collection`) the ``get_facecolor`` method.
 Note that setting to the ``.color`` attribute did not update the quiver artist,
 whereas calling ``set_facecolor`` does.
 
@@ -999,7 +999,7 @@ Transforms / scales
 - ``InvertedNaturalLogTransform``
 
 These classes defined in :mod:`matplotlib.scale` are deprecated.
-As a replacement, use the general `LogTransform` and `InvertedLogTransform`
+As a replacement, use the general `~.scale.LogTransform` and `~.scale.InvertedLogTransform`
 classes, whose constructors take a *base* argument.
 
 Locators / Formatters
@@ -1086,8 +1086,8 @@ The following API elements have bee un-deprecated:
 New features
 ------------
 
-`Text` now has a ``c`` alias for the ``color`` property
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+`.Text` now has a ``c`` alias for the ``color`` property
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 For consistency with `.Line2D`, the `~.text.Text` class has gained the ``c``
 alias for the ``color`` property. For example, one can now write ::
 

diff --git a/doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst b/doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst
@@ -62,12 +62,12 @@ Matplotlib used to recompute autoscaled limits after every plotting
 rendering the canvas, or when the user queries the Axes limits.  This is a
 major performance improvement for plots with a large number of artists.
 
-In particular, this means that artists added manually with `Axes.add_line`,
-`Axes.add_patch`, etc. will be taken into account by the autoscale, even
-without an explicit call to `Axes.autoscale_view`.
+In particular, this means that artists added manually with `.Axes.add_line`,
+`.Axes.add_patch`, etc. will be taken into account by the autoscale, even
+without an explicit call to `.Axes.autoscale_view`.
 
 In some cases, this can result in different limits being reported.  If this is
-an issue, consider triggering a draw with `fig.canvas.draw`.
+an issue, consider triggering a draw with ``fig.canvas.draw()``.
 
 Autoscaling has also changed for artists that are based on the `.Collection`
 class.  Previously, the method that calculates the automatic limits
@@ -230,7 +230,7 @@ performance penalty.  Anti-aliasing can be improved with other filters.
 
 rcParams
 ~~~~~~~~
-When using `RendererSVG` with ``rcParams["svg.image_inline"] ==
+When using `.RendererSVG` with ``rcParams["svg.image_inline"] ==
 True``, externally written images now use a single counter even if the
 ``renderer.basename`` attribute is overwritten, rather than a counter per
 basename.

diff --git a/doc/api/prev_api_changes/api_changes_3.2.0/deprecations.rst b/doc/api/prev_api_changes/api_changes_3.2.0/deprecations.rst
@@ -17,8 +17,8 @@ the resulting data.
 axes and axis
 ~~~~~~~~~~~~~
 Setting ``Axis.major.locator``, ``Axis.minor.locator``, ``Axis.major.formatter``
-or ``Axis.minor.formatter`` to an object that is not a subclass of `Locator` or
-`Formatter` (respectively) is deprecated.  Note that these attributes should
+or ``Axis.minor.formatter`` to an object that is not a subclass of `.Locator` or
+`.Formatter` (respectively) is deprecated.  Note that these attributes should
 usually be set using `Axis.set_major_locator`, `Axis.set_minor_locator`, etc.
 which already raise an exception when an object of the wrong class is passed.
 
@@ -113,8 +113,8 @@ Deprecation of the constructor means that classes inheriting from
 
 Locators
 ~~~~~~~~
-The unused `Locator.autoscale()` method is deprecated (pass the axis limits to
-`Locator.view_limits()` instead).
+The unused `.Locator.autoscale` method is deprecated (pass the axis limits to
+`.Locator.view_limits` instead).
 
 Animation
 ~~~~~~~~~
@@ -232,7 +232,7 @@ deprecated. Use an explicit list instead.
 Scales
 ~~~~~~
 Passing unsupported keyword arguments to `.ScaleBase` and its subclasses
-`.LinearScale`, and `.SymLogScale` is deprecated and will raise a `TypeError` in 3.3.
+`.LinearScale`, and `.SymmetricalLogScale` is deprecated and will raise a `TypeError` in 3.3.
 
 If extra kwargs are passed to `.LogScale`, `TypeError` will now be
 raised instead of `ValueError`.

diff --git a/doc/api/texmanager_api.rst b/doc/api/texmanager_api.rst
@@ -0,0 +1,8 @@
+*************************
+``matplotlib.texmanager``
+*************************
+
+.. automodule:: matplotlib.texmanager
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/toolkits/mplot3d.rst b/doc/api/toolkits/mplot3d.rst
@@ -11,11 +11,9 @@ mplot3d API
    :no-members:
    :no-undoc-members:
 
-
+.. module:: mpl_toolkits.mplot3d.axes3d
 .. currentmodule:: mpl_toolkits.mplot3d
 
-.. _toolkit_mplot3d-axesapi:
-
 :mod:`~mpl_toolkits.mplot3d.axes3d`
 ===================================
 
@@ -32,7 +30,8 @@ mplot3d API
    axes3d.Axes3D
 
 
-.. _toolkit_mplot3d-axisapi:
+.. module:: mpl_toolkits.mplot3d.axis3d
+.. currentmodule:: mpl_toolkits.mplot3d
 
 :mod:`~mpl_toolkits.mplot3d.axis3d`
 ===================================
@@ -53,7 +52,8 @@ mplot3d API
    axis3d.Axis
 
 
-.. _toolkit_mplot3d-artapi:
+.. module:: mpl_toolkits.mplot3d.art3d
+.. currentmodule:: mpl_toolkits.mplot3d
 
 :mod:`~mpl_toolkits.mplot3d.art3d`
 ==================================
@@ -90,7 +90,8 @@ Art3D Utility Functions
    art3d.rotate_axes
    art3d.text_2d_to_3d
 
-.. _toolkit_mplot3d-projapi:
+.. module:: mpl_toolkits.mplot3d.proj3d
+.. currentmodule:: mpl_toolkits.mplot3d
 
 :mod:`~mpl_toolkits.mplot3d.proj3d`
 ===================================

diff --git a/doc/api/toolkits/mplot3d/faq.rst b/doc/api/toolkits/mplot3d/faq.rst
@@ -47,6 +47,6 @@ Historically, mplot3d has suffered from a hard-coding of parameters used
 to control visuals such as label spacing, tick length, and grid line width.
 Work is being done to eliminate this issue. For matplotlib v1.1.0, there is
 a semi-official manner to modify these parameters. See the note in the
-:ref:`toolkit_mplot3d-axisapi` section of the mplot3d API documentation for
+:mod:`.mplot3d.axis3d` section of the mplot3d API documentation for
 more information.
 
diff --git a/doc/conf.py b/doc/conf.py
@@ -109,12 +109,13 @@ def _check_dependencies():
 
 intersphinx_mapping = {
     'python': ('https://docs.python.org/3', None),
+    'cycler': ('https://matplotlib.org/cycler', None),
+    'dateutil': ('https://dateutil.readthedocs.io/en/stable/', None),
     'numpy': ('https://docs.scipy.org/doc/numpy/', None),
-    'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None),
     'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None),
     'Pillow': ('https://pillow.readthedocs.io/en/stable/', None),
-    'cycler': ('https://matplotlib.org/cycler', None),
-    'dateutil': ('https://dateutil.readthedocs.io/en/stable/', None),
+    'pytest': ('https://pytest.org/en/stable', None),
+    'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None),
 }
 
 

diff --git a/doc/devel/MEP/MEP10.rst b/doc/devel/MEP/MEP10.rst
@@ -119,7 +119,7 @@ autosummary extension
 
 The Sphinx autosummary extension should be used to generate summary
 tables, that link to separate pages of documentation.  Some classes
-that have many methods (e.g. `Axes.axes`) should be documented with
+that have many methods (e.g. `~.axes.Axes`) should be documented with
 one method per page, whereas smaller classes should have all of their
 methods together.
 

diff --git a/doc/devel/MEP/MEP14.rst b/doc/devel/MEP/MEP14.rst
@@ -115,7 +115,7 @@ requires the installation of TeX-specific font packages, for example,
 and can not use TrueType fonts directly.  Unfortunately, despite the
 different semantics for font selection, the same set of font
 properties are used for each.  This is true of both the
-`FontProperties` class and the font-related `rcParams` (which
+`.FontProperties` class and the font-related `.rcParams` (which
 basically share the same code underneath).  Instead, we should define
 a core set of font selection parameters that will work across all text
 engines, and have engine-specific configuration to allow the user to
@@ -202,9 +202,11 @@ possible.
 
 Alternative font subsetting options include using the subsetting
 built-in to Cairo (not clear if it can be used without the rest of
-Cairo), or using `fontforge` (which is a heavy and not terribly
+Cairo), or using fontforge_ (which is a heavy and not terribly
 cross-platform dependency).
 
+.. _fontforge: https://fontforge.org
+
 **Freetype wrappers**
 
 Our FreeType wrapper could really use a reworking.  It defines its own
@@ -254,7 +256,7 @@ arbitrary text engine in another should be possible.
 The text mode is currently set by a global rcParam ("text.usetex") so
 it's either all on or all off.  We should continue to have a global
 rcParam to choose the text engine ("text.layout_engine"), but it
-should under the hood be an overridable property on the `Text` object,
+should under the hood be an overridable property on the `.Text` object,
 so the same figure can combine the results of multiple text layout
 engines if necessary.
 

diff --git a/doc/devel/MEP/MEP15.rst b/doc/devel/MEP/MEP15.rst
@@ -18,15 +18,15 @@ None so far.
 Abstract
 ========
 
-When one axis of a 2-dimensional plot if overridden via `xlim` or `ylim`,
+When one axis of a 2-dimensional plot if overridden via `~.Axes.set_xlim` or `~.Axes.set_ylim`,
 automatic scaling of the remaining axis should be based on the data that falls
 within the specified limits of the first axis.
 
 Detailed description
 ====================
 
-When axis limits for a 2-D plot are specified for one axis only (via `xlim` or
-`ylim`), matplotlib currently does not currently rescale the other axis.  The
+When axis limits for a 2-D plot are specified for one axis only (via `~.Axes.set_xlim` or
+`~.Axes.set_ylim`), matplotlib currently does not currently rescale the other axis.  The
 result is that the displayed curves or symbols may be compressed into a tiny
 portion of the available area, so that the final plot conveys much less
 information than it would with appropriate axis scaling.

diff --git a/doc/devel/MEP/MEP22.rst b/doc/devel/MEP/MEP22.rst
@@ -77,7 +77,7 @@ ToolBase(object)
 
 Tools can have a graphical representation as the `SubplotTool` or not even be present in the Toolbar as `Quit`
 
-The `ToolBase` has the following class attributes for configuration at definition time
+The `.ToolBase` has the following class attributes for configuration at definition time
 
  * keymap = None: Key(s) to be used to trigger the tool
  * description = '': Small description of the tool
@@ -113,7 +113,7 @@ The following instance attributes are set at instantiation:
 ToolToggleBase(ToolBase)
 ------------------------
 
-The `ToolToggleBase` has the following class attributes for
+The `.ToolToggleBase` has the following class attributes for
 configuration at definition time
 
  * radio_group = None: Attribute to group 'radio' like tools (mutually
@@ -124,7 +124,7 @@ The **Toggleable** Tools, can capture keypress, mouse moves, and mouse
 button press
 
 It defines the following methods
- * enable(self, event): Called by `ToolToggleBase.trigger` method
+ * enable(self, event): Called by `.ToolToggleBase.trigger` method
  * disable(self, event): Called when the tool is untoggled
  * toggled : **Property** True or False
 

diff --git a/doc/devel/coding_guide.rst b/doc/devel/coding_guide.rst
@@ -164,9 +164,11 @@ Automated tests
 
   - Whenever a pull request is created or updated, Travis and Appveyor
     automatically runs the test suite on all versions of Python
-    supported by Matplotlib.  The `tox` support in Matplotlib may be
+    supported by Matplotlib.  The tox_ support in Matplotlib may be
     useful for testing locally.
 
+  .. _tox: https://tox.readthedocs.io/
+
 * Do not self merge, except for 'small' patches to un-break the CI or
   when another reviewer explicitly allows it (ex, "Approve modulo CI
   passing, may self merge when green").
@@ -316,4 +318,4 @@ and then continue the cherry pick::
   git cherry-pick --continue
 
 Use your discretion to push directly to upstream or to open a PR; be
-sure to push or PR against the `v2.2.x` upstream branch, not `master`!
+sure to push or PR against the ``v2.2.x`` upstream branch, not ``master``!
diff --git a/doc/devel/contributing.rst b/doc/devel/contributing.rst
@@ -444,7 +444,7 @@ To include `logging` in your module, at the top of the module, you need to
 will log to a logger named ``matplotlib.yourmodulename``.
 
 If an end-user of Matplotlib sets up `logging` to display at levels
-more verbose than `logger.WARNING` in their code with the Matplotlib-provided
+more verbose than `logging.WARNING` in their code with the Matplotlib-provided
 helper::
 
   plt.set_loglevel("debug")

diff --git a/doc/devel/testing.rst b/doc/devel/testing.rst
@@ -46,7 +46,7 @@ Running the tests is simple. Make sure you have pytest installed and run::
 
 in the root directory of the repository.
 
-`pytest` can be configured via a lot of `commandline parameters`_. Some
+pytest can be configured via a lot of `commandline parameters`_. Some
 particularly useful ones are:
 
 =============================  ===========
@@ -160,7 +160,7 @@ the tests, they should now pass.
 Baseline images take a lot of space in the Matplotlib repository.
 An alternative approach for image comparison tests is to use the
 `~matplotlib.testing.decorators.check_figures_equal` decorator, which should be
-used to decorate a function taking two `Figure` parameters and draws the same
+used to decorate a function taking two `.Figure` parameters and draws the same
 images on the figures using two different methods (the tested method and the
 baseline method).  The decorator will arrange for setting up the figures and
 then collect the drawn results and compare them.