Skip to content

Commit fbb44c9

Browse files
author
Higgs32584
committed
Merge branch 'documentation_1' of https://github.com/Higgs32584/matplotlib into documentation_1
2 parents ce8078d + a03498d commit fbb44c9

File tree

29 files changed

+295
-301
lines changed

29 files changed

+295
-301
lines changed

‎.github/codecov.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,12 @@ coverage:
2121
if_no_uploads: error
2222
if_not_found: success
2323
if_ci_failed: failure
24-
paths: '!lib/.*/tests/.*'
24+
paths:
25+
- '!lib/.*/tests/.*'
2526
tests:
2627
target: auto
2728
if_no_uploads: error
2829
if_not_found: success
2930
if_ci_failed: failure
30-
paths: 'lib/.*/tests/.*'
31+
paths:
32+
- 'lib/.*/tests/.*'

‎.github/workflows/mypy-stubtest.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ jobs:
2020

2121
- name: Install mypy
2222
run: |
23+
<<<<<<< HEAD
2324
pip3 install -r requirements/testing/mypy.txt -r requirements/testing/all.txt
2425
pip3 install .
2526

@@ -28,3 +29,37 @@ jobs:
2829
# the ignore missing imports can be removed when typed cycler is released and used
2930
MPLBACKEND=agg python -m mypy.stubtest matplotlib --mypy-config-file pyproject.toml \
3031
--allowlist ci/mypy-stubtest-allowlist.txt
32+
=======
33+
pip3 install -r requirements/testing/mypy.txt \
34+
-r requirements/testing/all.txt
35+
pip3 install -e .
36+
37+
- name: Set up reviewdog
38+
run: |
39+
mkdir -p "$HOME/bin"
40+
curl -sfL \
41+
https://github.com/reviewdog/reviewdog/raw/master/install.sh | \
42+
sh -s -- -b "$HOME/bin"
43+
echo "$HOME/bin" >> $GITHUB_PATH
44+
45+
- name: Run mypy stubtest
46+
env:
47+
REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
48+
run: |
49+
set -o pipefail
50+
MPLBACKEND=agg python -m mypy.stubtest \
51+
--mypy-config-file pyproject.toml \
52+
--allowlist ci/mypy-stubtest-allowlist.txt \
53+
matplotlib | \
54+
reviewdog \
55+
-efm '%Eerror: %m' \
56+
-efm '%CStub: in file %f:%l' \
57+
-efm '%CStub: in file %f' \
58+
-efm '%+CRuntime:%.%#' \
59+
-efm '%+CMISSING' \
60+
-efm '%+Cdef %.%#' \
61+
-efm '%+C<%.%#>' \
62+
-efm '%Z' \
63+
-reporter=github-check -tee -name=mypy-stubtest \
64+
-filter-mode=nofilter
65+
>>>>>>> a03498d1ab6ad43da62c3dee9b17b0cf1930745f

‎azure-pipelines.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ pr:
1111
branches:
1212
exclude:
1313
- v*-doc
14+
paths:
15+
exclude:
16+
- doc/**/*
17+
- galleries/**/*
1418

1519
stages:
1620

‎doc/_static/mpl.css

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,12 +62,11 @@ html[data-theme="dark"] .sphx-glr-thumbcontainer {
6262
padding: 0;
6363
}
6464

65-
/* hide note linking to the download section at the bottom of galleries
66-
* as suggested in https://github.com/sphinx-gallery/sphinx-gallery/issues/760
65+
/* hide download buttons in example headers
66+
* https://sphinx-gallery.github.io/stable/advanced.html#hide-the-download-buttons-in-the-example-headers
6767
*/
6868
div.sphx-glr-download-link-note {
69-
height: 0px;
70-
visibility: hidden;
69+
display: none;
7170
}
7271

7372
/* re-style the download button */

‎doc/api/next_api_changes/behavior/25697-AL.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Invalid types for Annotation xycoords now raise TypeError
2+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3+
Previously, a `RuntimeError` would be raised in some cases.

‎doc/devel/coding_guide.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,8 @@ will run on all supported platforms and versions of Python.
369369
individual commits by including the following substrings in commit messages:
370370

371371
- ``[ci doc]``: restrict the CI to documentation checks. For when you only
372-
changed documentation.
372+
changed documentation (this skip is automatic if the changes are only under
373+
``doc/`` or ``galleries/``).
373374
- ``[skip circle]``: skip the documentation build check. For when you didn't
374375
change documentation.
375376
- Unit tests can be turned off for individual platforms with

‎doc/users/next_whats_new/get_suptitle.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
``Figure.get_suptitle()``, ``Figure.get_supxlabel()``, ``Figure.get_supylabel()``
2+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3+
These methods return the strings set by ``Figure.suptitle()``, ``Figure.supxlabel()``
4+
and ``Figure.supylabel()`` respectively.

‎doc/users/next_whats_new/mathtext_supports_text.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,23 @@
11
``mathtext`` now supports ``\text``
22
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33

4+
<<<<<<< HEAD
45
``\text`` can be used to obtain upright text within an equation.
6+
=======
7+
``\text`` can be used to obtain upright text within an equation and to get a plain dash
8+
(-).
9+
>>>>>>> a03498d1ab6ad43da62c3dee9b17b0cf1930745f
510

611
.. plot::
712
:include-source: true
813
:alt: Illustration of the newly added \text command, showing that it renders as normal text, including spaces, despite being part of an equation. Also show that a dash is not rendered as a minus when part of a \text command.
914

15+
<<<<<<< HEAD
1016
import matplotlib.pyplot as plt
1117
plt.text(0.1, 0.5, r"$a = \sin(\phi) \text{ such that } \phi = \frac{x}{y}$")
1218
plt.text(0.1, 0.3, r"$\text{dashes (-) are retained}$")
19+
=======
20+
import matplotlib.pyplot as plt
21+
plt.text(0.1, 0.5, r"$a = \sin(\phi) \text{ such that } \phi = \frac{x}{y}$")
22+
plt.text(0.1, 0.3, r"$\text{dashes (-) are retained}$")
23+
>>>>>>> a03498d1ab6ad43da62c3dee9b17b0cf1930745f

‎galleries/users_explain/axes/autoscale.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,15 @@
2929
# %%
3030
# Margins
3131
# -------
32-
# The default margin around the data limits is 5%:
32+
# The default margin around the data limits is 5%, which is based on the
33+
# default configuration setting of :rc:`axes.xmargin`, :rc:`axes.ymargin`,
34+
# and :rc:`axes.zmargin`:
3335

3436
print(ax.margins())
3537

3638
# %%
37-
# The margins can be made larger using `~matplotlib.axes.Axes.margins`:
39+
# The margin size can be overridden to make them smaller or larger using
40+
# `~matplotlib.axes.Axes.margins`:
3841

3942
fig, ax = plt.subplots()
4043
ax.plot(x, y)

‎galleries/users_explain/toolkits/index.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,34 @@ User Toolkits
77

88
Here you can find examples and explanations of how to use various toolkits available in Matplotlib.
99

10+
<<<<<<< HEAD
1011
.. toctree::
1112
:maxdepth: 1
1213

1314
axisartist
1415
axes_grid
16+
=======
17+
Axes Artist
18+
-----------
19+
20+
.. toctree::
21+
:maxdepth: 1
22+
23+
axesartist
24+
25+
Axes Grid
26+
---------
27+
28+
.. toctree::
29+
:maxdepth: 1
30+
31+
axes_grid
32+
33+
Mplot3D
34+
-------
35+
36+
.. toctree::
37+
:maxdepth: 1
38+
39+
>>>>>>> a03498d1ab6ad43da62c3dee9b17b0cf1930745f
1540
mplot3d

0 commit comments

Comments
 (0)