Skip to content

Commit aa87ae3

Browse files
QuLogicQuLogic
committed
Merge branch 'v2.2.2-doc' into v2.2.x
2 parents d1214fa + 758e965 commit aa87ae3

Some content is hidden

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

55 files changed

+916
-172
lines changed

‎INSTALL.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -330,14 +330,14 @@ without fiddling with environment variables::
330330
conda install -c conda-forge backports.functools_lru_cache
331331

332332
# copy the libs which have "wrong" names
333-
set LIBRARY_LIB=%CONDA_DEFAULT_ENV%\Library\lib
333+
set LIBRARY_LIB=%CONDA_PREFIX%\Library\lib
334334
mkdir lib || cmd /c "exit /b 0"
335335
copy %LIBRARY_LIB%\zlibstatic.lib lib\z.lib
336336
copy %LIBRARY_LIB%\libpng_static.lib lib\png.lib
337337

338338
# Make the header files and the rest of the static libs available during the build
339339
# CONDA_DEFAULT_ENV is a env variable which is set to the currently active environment path
340-
set MPLBASEDIRLIST=%CONDA_DEFAULT_ENV%\Library\;.
340+
set MPLBASEDIRLIST=%CONDA_PREFIX%\Library\;.
341341

342342
# build the wheel
343343
python setup.py bdist_wheel

‎README.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,3 +81,5 @@ You've worked out a way to fix it – even better!
8181
You want to tell us about it – best of all!
8282

8383
Start at the `contributing guide <http://matplotlib.org/devdocs/devel/contributing.html>`_!
84+
85+
Developer notes are now at `_Developer Discussions <https://github.com/orgs/matplotlib/teams/developers/discussions>`_

‎doc/_static/mpl.css

Lines changed: 72 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -232,9 +232,6 @@ div.sphinxsidebar {
232232
text-align: left;
233233
/* margin-left: -100%; */
234234
}
235-
div.sphinxsidebarwrapper {
236-
padding-top: 28px
237-
}
238235

239236
div.sphinxsidebar h4, div.sphinxsidebar h3 {
240237
margin: 1em 0 0.5em 0;
@@ -245,6 +242,11 @@ div.sphinxsidebar h4, div.sphinxsidebar h3 {
245242
background-color: #AFC1C4;
246243
}
247244

245+
div.sphinxsidebar h3 a {
246+
/* workaround for table of contents heading, which is a link */
247+
color: white !important;
248+
}
249+
248250
div.sphinxsidebar ul {
249251
padding-left: 1.5em;
250252
margin-top: 7px;
@@ -258,6 +260,36 @@ div.sphinxsidebar ul ul {
258260
margin-left: 20px;
259261
}
260262

263+
div.sphinxsidebar #searchbox input {
264+
border: 1px solid #aaa;
265+
padding: 0.25em;
266+
box-sizing: border-box;
267+
}
268+
269+
div.sphinxsidebar #searchbox form {
270+
display: inline-block;
271+
width: 100%
272+
}
273+
274+
div.sphinxsidebar #searchbox input[type="text"] {
275+
float: left;
276+
width: 80%;
277+
}
278+
279+
div.sphinxsidebar #searchbox input[type="submit"] {
280+
float: left;
281+
width: 20%;
282+
border-left: none;
283+
}
284+
285+
div.sphinxsidebar #searchbox input[type="submit"]:hover {
286+
background: #ddd;
287+
}
288+
289+
div.sphinxsidebar .searchformwrapper {
290+
display: block;
291+
}
292+
261293
p {
262294
margin: 0.8em 0 0.8em 0;
263295
}
@@ -277,11 +309,11 @@ h2 {
277309
margin: 0.5em 0 0.2em 0;
278310
padding-top: 0.5em;
279311
font-size: 1.7em;
280-
padding: 0;
281312
}
282313

283314
h3 {
284315
margin: 0.2em 0 0.1em 0;
316+
padding-top: 0.5em;
285317
font-size: 1.2em;
286318
}
287319

@@ -670,7 +702,7 @@ table.docutils.field-list {
670702
padding: 10px;
671703
text-align: left;
672704
vertical-align: top;
673-
width: 120px;
705+
width: 125px;
674706
}
675707
.docutils.field-list td {
676708
padding: 10px 10px 10px 20px;
@@ -736,6 +768,26 @@ figcaption {
736768
text-align: center;
737769
}
738770

771+
772+
/* "Summer Fellowship" message. */
773+
#summer-fellowship {
774+
background: #11557C;
775+
box-sizing: border-box;
776+
color: #fffa;
777+
font-weight: bold;
778+
left: 0;
779+
min-height: 3em;
780+
padding: 0.5em;
781+
top: 0;
782+
width: 100%;
783+
z-index: 10000;
784+
}
785+
786+
#summer-fellowship a {
787+
color: #fff;
788+
text-decoration:underline;
789+
}
790+
739791
/* "Go to released version" message. */
740792
#unreleased-message {
741793
background: #d62728;
@@ -813,11 +865,13 @@ figcaption {
813865
}
814866
}
815867

868+
#sidebar-donations {
869+
margin-top: 40px;
870+
}
871+
816872
.donate_button {
817873
background:#11557C;
818874
font-weight:normal;
819-
border:solid 1px #fff;
820-
outline: solid 1px #11557C;
821875
clear: both;
822876
display: block;
823877
width:200px;
@@ -828,6 +882,7 @@ figcaption {
828882
color:#fff;
829883
text-decoration: none;
830884
margin: 30px auto 0;
885+
border-radius: 6px;
831886
z-index:1;
832887
transition: background .25s ease;
833888
}
@@ -936,3 +991,13 @@ p.sphx-glr-signature a.reference.external {
936991
font-weight: 400;
937992
}
938993

994+
.sidebar-announcement {
995+
border: 1px solid #11557C;
996+
background: #eff9ff;
997+
padding: 2px;
998+
margin-top: 40px;
999+
}
1000+
1001+
.sidebar-announcement p {
1002+
margin: 0.4em 0.4em 0.6em 0.4em;
1003+
}

‎doc/_templates/donate_sidebar.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
<div>
2+
<div id="sidebar-donations">
33
<a href="https://www.flipcause.com/secure/cause_pdetails/MjI1OA==" target="_blank"> <div class="donate_button" >Support Matplotlib</div></a>
44
<a href="https://www.flipcause.com/secure/cause_pdetails/MTY3NTU=" target="_blank"> <div class="donate_button" >Support NumFOCUS</div></a>
55
</div>

‎doc/_templates/layout.html

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,12 @@ <h3>{{ _('Navigation') }}</h3>
172172
</a>
173173
</div>
174174
{%- endif %}
175+
<div id="summer-fellowship">
176+
Applications are open for the 2018 John Hunter Matplotlib Summer Fellowship.
177+
<a href="https://www.numfocus.org/programs/john-hunter-technology-fellowship">
178+
Apply now!
179+
</a>
180+
</div>
175181
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
176182
{%- if builder in ('htmlhelp', 'devhelp', 'latex') %}
177183
<a href="{{ pathto('index') }}">
@@ -231,13 +237,16 @@ <h3>{{ _('Navigation') }}</h3>
231237
endtrans %}
232238
{%- endif %}
233239
{%- endif %}
240+
<br />
234241
{%- if last_updated %}
235-
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated
236-
}}.{% endtrans %}
242+
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
237243
{%- endif %}
238244
{%- if show_sphinx %}
239-
{% trans sphinx_version=sphinx_version|e %}Created using <a
240-
href="http://sphinx-doc.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}
245+
{% trans sphinx_version=sphinx_version|e %}Created using
246+
<ahref="http://sphinx-doc.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}
247+
{%- endif %}
248+
{%- if sha %}
249+
Doc version {{ sha }}.
241250
{%- endif %}
242251
</div>
243252
{%- endblock %}

‎doc/_templates/pagesource.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{%- if show_source and has_source and sourcename %}
2+
<div id="sidebar-pagesource" role="note" aria-label="source link"
3+
style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">
4+
<a href="{{ pathto('_sources/' + sourcename, true)|e }}"
5+
style="color: #c0c0c0" rel="nofollow">{{ _('Show Page Source') }}</a>
6+
</div>
7+
{%- endif %}

‎doc/_templates/sidebar_announcement.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<div class="sidebar-announcement">
2+
<p>The upcoming version Matplotlib 3.0 will be Python 3 only.</p>
3+
<p>For Python 2 support, Matplotlib 2.2.x will be continued as a LTS release
4+
and updated with bugfixes until January 1, 2020.</p>
5+
</div>

‎doc/citing.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,12 @@ publication, please acknowledge this fact by citing `Hunter et al (2007)
2727
2828
DOIs
2929
----
30+
v2.2.2
31+
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1202077.svg
32+
:target: https://doi.org/10.5281/zenodo.1202077
33+
v2.2.1
34+
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1202050.svg
35+
:target: https://doi.org/10.5281/zenodo.1202050
3036
v2.2.0
3137
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1189358.svg
3238
:target: https://doi.org/10.5281/zenodo.1189358

‎doc/conf.py

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -153,11 +153,18 @@ def _check_deps():
153153
master_doc = 'contents'
154154

155155
# General substitutions.
156+
from matplotlib.compat.subprocess import check_output
157+
SHA = check_output(['git', 'describe', '--dirty']).decode('utf-8').strip()
158+
159+
html_context = {'sha': SHA}
160+
156161
project = 'Matplotlib'
157162
copyright = ('2002 - 2012 John Hunter, Darren Dale, Eric Firing, '
158163
'Michael Droettboom and the Matplotlib development '
159164
'team; 2012 - 2018 The Matplotlib development team')
160165

166+
167+
161168
# The default replacements for |version| and |release|, also used in various
162169
# other places throughout the built documents.
163170
#
@@ -243,9 +250,10 @@ def _check_deps():
243250

244251
# Custom sidebar templates, maps page names to templates.
245252
html_sidebars = {
246-
'index': ['donate_sidebar.html', 'searchbox.html'],
247-
'**': ['localtoc.html', 'relations.html',
248-
'sourcelink.html', 'searchbox.html']
253+
'index': ['searchbox.html', 'sidebar_announcement.html',
254+
'donate_sidebar.html'],
255+
'**': ['searchbox.html', 'localtoc.html', 'relations.html',
256+
'pagesource.html']
249257
}
250258

251259
# If false, no module index is generated.

‎doc/devel/MEP/MEP08.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@
99
Status
1010
======
1111

12-
**Discussion**
12+
**Completed**
13+
14+
We are currently enforcing a sub-set of pep8 on new code contributions.
1315

1416
Branches and Pull requests
1517
==========================

‎doc/devel/MEP/MEP09.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ by the user.
1111

1212
Status
1313
======
14+
1415
**Discussion**
1516

1617
Branches and Pull requests

‎doc/devel/MEP/MEP10.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,11 @@ Status
99

1010
**Progress**
1111

12-
Targeted for 1.3
12+
This is still an on-going effort
1313

1414
Branches and Pull requests
1515
==========================
1616

17-
#1665
18-
#1757
19-
#1795
2017

2118
Abstract
2219
========

‎doc/devel/MEP/MEP19.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Status
66
======
77

8-
**Discussion**
8+
**Completed**
99

1010
Branches and Pull requests
1111
==========================

‎doc/devel/MEP/MEP26.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
Status
1010
======
1111

12-
**Proposed**
12+
**Rejected**
1313

1414
Branches and Pull requests
1515
==========================

‎doc/devel/MEP/MEP27.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
Status
1010
======
11-
**Discussion**
11+
**Progress**
1212

1313
Branches and Pull requests
1414
==========================

‎doc/devel/MEP/README.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
:orphan:
2+
3+
4+
################################
5+
Matplotlib Enhancement Proposals
6+
################################
7+
8+
Matplotlib Enhancement Proposals (MEP), inspired by cpython's `PEP's
9+
<https://www.python.org/dev/peps/>`__ but less formal, are design
10+
documents for large or controversial changes to Matplotilb. These
11+
documents should provide a discussion of both why and how the changes
12+
should be made.
13+
14+
To create a new MEP open a pull request (PR) adding a file based on
15+
:ref:`the template <MEP-template>` to this the MEP directory. For the
16+
initial PR only a rough description is required and it should be
17+
merged quickly. Further detailed discussion can happen in follow on
18+
PRs.

‎doc/devel/MEP/index.rst

Lines changed: 6 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
.. _MEP-index:
22

3-
################################
4-
Matplotlib Enhancement Proposals
5-
################################
3+
.. include:: README.rst
64

75
.. htmlonly::
86

@@ -13,22 +11,9 @@ Matplotlib Enhancement Proposals
1311
:maxdepth: 1
1412

1513
template
16-
MEP08
17-
MEP09
18-
MEP10
19-
MEP11
20-
MEP12
21-
MEP13
22-
MEP14
23-
MEP15
24-
MEP19
25-
MEP21
26-
MEP22
27-
MEP23
28-
MEP24
29-
MEP25
30-
MEP26
31-
MEP27
32-
MEP28
33-
MEP29
3414

15+
.. toctree::
16+
:glob:
17+
:maxdepth: 1
18+
19+
MEP*

0 commit comments

Comments
 (0)