Skip to content

Merge branch v3.7.2-doc into v3.7.x #26428

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Aug 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions doc/_static/zenodo_cache/8118151.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions doc/api/font_manager_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
:undoc-members:
:show-inheritance:

.. data:: fontManager
.. data:: fontManager

The global instance of `FontManager`.
The global instance of `FontManager`.

.. autoclass:: FontEntry
:no-undoc-members:
6 changes: 3 additions & 3 deletions doc/api/style_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ the builtin styles.
.. imported variables have to be specified explicitly due to
https://github.com/sphinx-doc/sphinx/issues/6607

.. data:: matplotlib.style.library
.. data:: library

A dict mapping from style name to `.RcParams` defining that style.
A dict mapping from style name to `.rcParams` defining that style.

This is meant to be read-only. Use `.reload_library` to update.

.. data:: matplotlib.style.available
.. data:: available

List of the names of the available styles.

Expand Down
21 changes: 18 additions & 3 deletions doc/devel/documenting_mpl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -187,9 +187,24 @@ nor the ````literal```` role:
Referring to other documents and sections
-----------------------------------------

Sphinx_ allows internal references_ between documents.
Sphinx_ supports internal references_:

Documents can be linked with the ``:doc:`` directive:
========== =============== ===========================================
Role Links target Representation in rendered HTML
========== =============== ===========================================
|doc-dir|_ document link to a page
|ref-dir|_ reference label link to an anchor associated with a heading
========== =============== ===========================================

.. The following is a hack to have a link with literal formatting
See https://stackoverflow.com/a/4836544

.. |doc-dir| replace:: ``:doc:``
.. _doc-dir: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-doc
.. |ref-dir| replace:: ``:ref:``
.. _ref-dir: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-ref

Examples:

.. code-block:: rst

Expand All @@ -207,7 +222,7 @@ will render as:

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

Sections can also be given reference names. For instance from the
Sections can also be given reference labels. For instance from the
:doc:`/users/installing/index` link:

.. code-block:: rst
Expand Down
3 changes: 3 additions & 0 deletions doc/users/project/citing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ By version
.. START OF AUTOGENERATED


v3.7.2
.. image:: ../../_static/zenodo_cache/8118151.svg
:target: https://doi.org/10.5281/zenodo.8118151
v3.7.1
.. image:: ../../_static/zenodo_cache/7697899.svg
:target: https://doi.org/10.5281/zenodo.7697899
Expand Down
2 changes: 2 additions & 0 deletions examples/README.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@

.. _examples-index:

.. _gallery:

========
Examples
========
For an overview of the plotting methods we provide, see :ref:`plot_types`

This page contains example plots. Click on any image to see the full image
and source code.
Expand Down
3 changes: 1 addition & 2 deletions examples/misc/packed_bubbles.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,7 @@ def check_collisions(self, bubble, bubbles):

def collides_with(self, bubble, bubbles):
distance = self.outline_distance(bubble, bubbles)
idx_min = np.argmin(distance)
return idx_min if type(idx_min) == np.ndarray else [idx_min]
return np.argmin(distance, keepdims=True)

def collapse(self, n_iterations=50):
"""
Expand Down
2 changes: 1 addition & 1 deletion examples/showcase/anatomy.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ def annotate(x, y, text, code):
color = 'white' if path_effects else royal_blue
ax.text(x, y-0.2, text, zorder=100,
ha='center', va='top', weight='bold', color=color,
style='italic', fontfamily='Courier New',
style='italic', fontfamily='monospace',
path_effects=path_effects)

color = 'white' if path_effects else 'black'
Expand Down
13 changes: 12 additions & 1 deletion examples/style_sheets/style_sheets_reference.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,19 @@

This script demonstrates the different available style sheets on a
common set of example plots: scatter plot, image, bar graph, patches,
line plot and histogram,
line plot and histogram.

Any of these style sheets can be imported (i.e. activated) by its name.
For example for the ggplot style:

>>> plt.style.use('ggplot')

The names of the available style sheets can be found
in the list `matplotlib.style.available`
(they are also printed in the corner of each plot below).

See more details in :ref:`Customizing Matplotlib
using style sheets<customizing-with-style-sheets>`.
"""

import numpy as np
Expand Down
2 changes: 1 addition & 1 deletion lib/matplotlib/dviread.py
Original file line number Diff line number Diff line change
Expand Up @@ -622,7 +622,7 @@ def __init__(self, scale, tfm, texname, vf):
for char in range(nchars)]

def __eq__(self, other):
return (type(self) == type(other)
return (type(self) is type(other)
and self.texname == other.texname and self.size == other.size)

def __ne__(self, other):
Expand Down
2 changes: 1 addition & 1 deletion lib/matplotlib/font_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -851,7 +851,7 @@ def set_fontconfig_pattern(self, pattern):
pattern syntax for use here.
"""
for key, val in parse_fontconfig_pattern(pattern).items():
if type(val) == list:
if type(val) is list:
getattr(self, "set_" + key)(val[0])
else:
getattr(self, "set_" + key)(val)
Expand Down
4 changes: 2 additions & 2 deletions lib/matplotlib/tests/test_axes.py
Original file line number Diff line number Diff line change
Expand Up @@ -2834,12 +2834,12 @@ def _as_mpl_axes(self):

# testing axes creation with plt.axes
ax = plt.axes([0, 0, 1, 1], projection=prj)
assert type(ax) == PolarAxes
assert type(ax) is PolarAxes
plt.close()

# testing axes creation with subplot
ax = plt.subplot(121, projection=prj)
assert type(ax) == PolarAxes
assert type(ax) is PolarAxes
plt.close()


Expand Down
6 changes: 3 additions & 3 deletions lib/matplotlib/tests/test_cbook.py
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ def test_callback_complete(self, pickle):

# test that we can add a callback
cid1 = self.connect(self.signal, mini_me.dummy, pickle)
assert type(cid1) == int
assert type(cid1) is int
self.is_not_empty()

# test that we don't add a second callback
Expand All @@ -249,7 +249,7 @@ def test_callback_disconnect(self, pickle):

# test that we can add a callback
cid1 = self.connect(self.signal, mini_me.dummy, pickle)
assert type(cid1) == int
assert type(cid1) is int
self.is_not_empty()

self.disconnect(cid1)
Expand All @@ -267,7 +267,7 @@ def test_callback_wrong_disconnect(self, pickle):

# test that we can add a callback
cid1 = self.connect(self.signal, mini_me.dummy, pickle)
assert type(cid1) == int
assert type(cid1) is int
self.is_not_empty()

self.disconnect("foo")
Expand Down
2 changes: 1 addition & 1 deletion lib/matplotlib/tests/test_image.py
Original file line number Diff line number Diff line change
Expand Up @@ -1461,6 +1461,6 @@ def test_str_norms(fig_test, fig_ref):
axrs[3].imshow(t, norm=colors.SymLogNorm(linthresh=2, vmin=.3, vmax=.7))
axrs[4].imshow(t, norm="logit", clim=(.3, .7))

assert type(axts[0].images[0].norm) == colors.LogNorm # Exactly that class
assert type(axts[0].images[0].norm) is colors.LogNorm # Exactly that class
with pytest.raises(ValueError):
axts[0].imshow(t, norm="foobar")
8 changes: 4 additions & 4 deletions lib/matplotlib/tests/test_scale.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,22 +37,22 @@ def test_symlog_mask_nan():
x = np.arange(-1.5, 5, 0.5)
out = slti.transform_non_affine(slt.transform_non_affine(x))
assert_allclose(out, x)
assert type(out) == type(x)
assert type(out) is type(x)

x[4] = np.nan
out = slti.transform_non_affine(slt.transform_non_affine(x))
assert_allclose(out, x)
assert type(out) == type(x)
assert type(out) is type(x)

x = np.ma.array(x)
out = slti.transform_non_affine(slt.transform_non_affine(x))
assert_allclose(out, x)
assert type(out) == type(x)
assert type(out) is type(x)

x[3] = np.ma.masked
out = slti.transform_non_affine(slt.transform_non_affine(x))
assert_allclose(out, x)
assert type(out) == type(x)
assert type(out) is type(x)


@image_comparison(['logit_scales.png'], remove_text=True)
Expand Down
1 change: 1 addition & 0 deletions tools/cache_zenodo_svg.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ def _get_xdg_cache_dir():

if __name__ == "__main__":
data = {
"v3.7.2": "8118151",
"v3.7.1": "7697899",
"v3.7.0": "7637593",
"v3.6.3": "7527665",
Expand Down