-
Notifications
You must be signed in to change notification settings - Fork 61
Expand file tree
/
Copy pathindex.html
More file actions
282 lines (261 loc) · 19.9 KB
/
Copy pathindex.html
File metadata and controls
282 lines (261 loc) · 19.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>The Matplotlib Developers' Guide — Matplotlib 3.4.3 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/mpl.css?v3.4.3-2-ge48e4acce0" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
<link rel="stylesheet" type="text/css" href="../_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-dataframe.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-rendered-html.css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/clipboard.min.js"></script>
<script src="../_static/copybutton.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.4.3 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Contributing" href="contributing.html" />
<link rel="prev" title="Third party packages" href="../thirdpartypackages/index.html" />
<link rel="top" title="Matplotlib 3.4.3 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/devel/index.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head><body>
<div id="unreleased-message"> You are reading an old version of the documentation (v3.4.3). For the latest version see <a href="https://matplotlib.org/stable/devel/index.html">https://matplotlib.org/stable/devel/index.html</a></div>
<!--
<div id="annc-banner">
</div>
-->
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../index.html">
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.4.3</span></div>
<img src="../_static/logo2_compressed.svg" height="125px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<nav class="main-nav">
<ul>
<li><a href="../users/installing.html">Installation</a></li>
<li><a href="../contents.html">Documentation</a></li>
<li><a href="../gallery/index.html">Examples</a></li>
<li><a href="../tutorials/index.html">Tutorials</a></li>
<li><a href="#">Contributing</a></li>
<li class="nav-right">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" placeholder="Search" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
</form>
</li>
</ul>
</nav>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="contributing.html" title="Contributing"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../thirdpartypackages/index.html" title="Third party packages"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../contents.html">contents</a> »</li>
<li class="nav-item nav-item-this"><a href="">The Matplotlib Developers' Guide</a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div id="sidebar-pagesource" role="note" aria-label="source link"
style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">
<a href="../_sources/devel/index.rst.txt"
style="color: #c0c0c0" rel="nofollow">Show Page Source</a>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="the-matplotlib-developers-guide">
<span id="developers-guide-index"></span><h1>The Matplotlib Developers' Guide<a class="headerlink" href="#the-matplotlib-developers-guide" title="Permalink to this headline">¶</a></h1>
<p>Thank you for your interest in helping to improve Matplotlib! There are various
ways to contribute to Matplotlib. All of them are super valuable but don't necessarily
require writing code at all. For example:</p>
<ul class="simple">
<li>contributing to the documentation</li>
<li>opening new issues for bugs</li>
<li>requesting new features</li>
<li>asking for clarification on things you find unclear</li>
<li>fixing bugs</li>
</ul>
<p>If you have any questions on the
process or how to fix something feel free to ask on <a class="reference external" href="https://gitter.im/matplotlib/matplotlib">gitter</a> for short questions and on
<a class="reference external" href="https://discourse.matplotlib.org">discourse</a> for longer questions.</p>
<div style="margin: 2em 0;">
<a href="contributing.html#submitting-a-bug-report"><span class="mpl-button">Report a bug</span></a>
<a href="contributing.html#request-a-new-feature"><span class="mpl-button">Request a feature</span></a>
<a href="contributing.html#contributing-code"><span class="mpl-button">Contribute code</span></a>
<a href="contributing.html#contributing-documentation"><span class="mpl-button">Write documentation</span></a>
</div><div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#contributor-incubator">Contributor Incubator</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#submitting-a-bug-report">Submitting a bug report</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#requesting-a-new-feature">Requesting a new feature</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#contributing-code">Contributing code</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#contributing-documentation">Contributing documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#other-ways-to-contribute">Other ways to contribute</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#coding-guidelines">Coding guidelines</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="triage.html">Bug triaging and issue curation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="triage.html#working-on-issues-to-improve-them">Working on issues to improve them</a></li>
<li class="toctree-l2"><a class="reference internal" href="triage.html#triage-team">Triage Team</a></li>
<li class="toctree-l2"><a class="reference internal" href="triage.html#triaging-operations-for-members-of-the-core-and-triage-teams">Triaging operations for members of the core and triage teams</a></li>
<li class="toctree-l2"><a class="reference internal" href="triage.html#a-typical-workflow-for-triaging-issues">A typical workflow for triaging issues</a></li>
<li class="toctree-l2"><a class="reference internal" href="triage.html#working-on-prs-to-help-review">Working on PRs to help review</a></li>
<li class="toctree-l2"><a class="reference internal" href="triage.html#acknowledgments">Acknowledgments</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="development_setup.html">Setting up Matplotlib for development</a><ul>
<li class="toctree-l2"><a class="reference internal" href="development_setup.html#creating-a-dedicated-environment">Creating a dedicated environment</a></li>
<li class="toctree-l2"><a class="reference internal" href="development_setup.html#retrieving-the-latest-version-of-the-code">Retrieving the latest version of the code</a></li>
<li class="toctree-l2"><a class="reference internal" href="development_setup.html#installing-matplotlib-in-editable-mode">Installing Matplotlib in editable mode</a></li>
<li class="toctree-l2"><a class="reference internal" href="development_setup.html#additional-dependencies-for-testing">Additional dependencies for testing</a></li>
<li class="toctree-l2"><a class="reference internal" href="development_setup.html#additional-dependencies-for-building-documentation">Additional dependencies for building documentation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="testing.html">Testing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="testing.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="testing.html#running-the-tests">Running the tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="testing.html#writing-a-simple-test">Writing a simple test</a></li>
<li class="toctree-l2"><a class="reference internal" href="testing.html#random-data-in-tests">Random data in tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="testing.html#writing-an-image-comparison-test">Writing an image comparison test</a></li>
<li class="toctree-l2"><a class="reference internal" href="testing.html#creating-a-new-module-in-matplotlib-tests">Creating a new module in matplotlib.tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="testing.html#using-github-actions-for-ci">Using GitHub Actions for CI</a></li>
<li class="toctree-l2"><a class="reference internal" href="testing.html#using-tox">Using tox</a></li>
<li class="toctree-l2"><a class="reference internal" href="testing.html#building-old-versions-of-matplotlib">Building old versions of Matplotlib</a></li>
<li class="toctree-l2"><a class="reference internal" href="testing.html#testing-released-versions-of-matplotlib">Testing released versions of Matplotlib</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="documenting_mpl.html">Writing documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="documenting_mpl.html#getting-started">Getting started</a></li>
<li class="toctree-l2"><a class="reference internal" href="documenting_mpl.html#writing-rest-pages">Writing ReST pages</a></li>
<li class="toctree-l2"><a class="reference internal" href="documenting_mpl.html#writing-docstrings">Writing docstrings</a></li>
<li class="toctree-l2"><a class="reference internal" href="documenting_mpl.html#writing-examples-and-tutorials">Writing examples and tutorials</a></li>
<li class="toctree-l2"><a class="reference internal" href="documenting_mpl.html#miscellaneous">Miscellaneous</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="add_new_projection.html">Developer's guide for creating scales and transformations</a><ul>
<li class="toctree-l2"><a class="reference internal" href="add_new_projection.html#creating-a-new-scale">Creating a new scale</a></li>
<li class="toctree-l2"><a class="reference internal" href="add_new_projection.html#creating-a-new-projection">Creating a new projection</a></li>
<li class="toctree-l2"><a class="reference internal" href="add_new_projection.html#api-documentation">API documentation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="gitwash/index.html">Working with <em>Matplotlib</em> source code</a><ul>
<li class="toctree-l2"><a class="reference internal" href="gitwash/git_intro.html">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="gitwash/git_install.html">Install git</a></li>
<li class="toctree-l2"><a class="reference internal" href="gitwash/following_latest.html">Following the latest source</a></li>
<li class="toctree-l2"><a class="reference internal" href="gitwash/patching.html">Making a patch</a></li>
<li class="toctree-l2"><a class="reference internal" href="gitwash/git_development.html">Git for development</a></li>
<li class="toctree-l2"><a class="reference internal" href="gitwash/git_resources.html">git resources</a></li>
<li class="toctree-l2"><a class="reference internal" href="gitwash/dot2_dot3.html">Two and three dots in difference specs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="coding_guide.html">Pull request guidelines</a><ul>
<li class="toctree-l2"><a class="reference internal" href="coding_guide.html#summary-for-pr-authors">Summary for PR authors</a></li>
<li class="toctree-l2"><a class="reference internal" href="coding_guide.html#summary-for-pr-reviewers">Summary for PR reviewers</a></li>
<li class="toctree-l2"><a class="reference internal" href="coding_guide.html#detailed-guidelines">Detailed Guidelines</a></li>
<li class="toctree-l2"><a class="reference internal" href="coding_guide.html#branches-and-backports">Branches and Backports</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="release_guide.html">Release Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="release_guide.html#testing">Testing</a></li>
<li class="toctree-l2"><a class="reference internal" href="release_guide.html#github-stats">GitHub Stats</a></li>
<li class="toctree-l2"><a class="reference internal" href="release_guide.html#update-and-validate-the-docs">Update and Validate the Docs</a></li>
<li class="toctree-l2"><a class="reference internal" href="release_guide.html#create-release-commit-and-tag">Create release commit and tag</a></li>
<li class="toctree-l2"><a class="reference internal" href="release_guide.html#release-management-doi">Release Management / DOI</a></li>
<li class="toctree-l2"><a class="reference internal" href="release_guide.html#building-binaries">Building binaries</a></li>
<li class="toctree-l2"><a class="reference internal" href="release_guide.html#make-distribution-and-upload-to-pypi">Make distribution and upload to PyPI</a></li>
<li class="toctree-l2"><a class="reference internal" href="release_guide.html#build-and-deploy-documentation">Build and Deploy Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="release_guide.html#announcing">Announcing</a></li>
<li class="toctree-l2"><a class="reference internal" href="release_guide.html#conda-packages">Conda packages</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="dependencies.html">Dependencies</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dependencies.html#mandatory-dependencies">Mandatory dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="dependencies.html#optional-dependencies">Optional dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="dependencies.html#c-libraries">C libraries</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="min_dep_policy.html">Minimum Version of Dependencies Policy</a><ul>
<li class="toctree-l2"><a class="reference internal" href="min_dep_policy.html#python-and-numpy">Python and NumPy</a></li>
<li class="toctree-l2"><a class="reference internal" href="min_dep_policy.html#python-dependencies">Python Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="min_dep_policy.html#test-and-documentation-dependencies">Test and Documentation Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="min_dep_policy.html#system-and-c-dependencies">System and C-dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="min_dep_policy.html#list-of-dependency-versions">List of dependency versions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="MEP/index.html">Matplotlib Enhancement Proposals</a><ul>
<li class="toctree-l2"><a class="reference internal" href="MEP/template.html">MEP Template</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP08.html">MEP8: PEP8</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP09.html">MEP9: Global interaction manager</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP10.html">MEP10: Docstring consistency</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP11.html">MEP11: Third-party dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP12.html">MEP12: Improve Gallery and Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP13.html">MEP13: Use properties for Artists</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP14.html">MEP14: Text handling</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP15.html">MEP15 - Fix axis autoscaling when limits are specified for one axis only</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP19.html">MEP19: Continuous Integration</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP21.html">MEP21: color and cm refactor</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP22.html">MEP22: Toolbar rewrite</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP23.html">MEP23: Multiple Figures per GUI window</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP24.html">MEP24: negative radius in polar plots</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP25.html">MEP25: Serialization</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP26.html">MEP26: Artist styling</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP27.html">MEP27: decouple pyplot from backends</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP28.html">MEP28: Remove Complexity from Axes.boxplot</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP29.html">MEP29: Text light markup</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<footer>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2021 The Matplotlib development team.
<br />
Last updated on Aug 13, 2021.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 3.4.3.
Doc version v3.4.3-2-ge48e4acce0.
</div>
</footer>
</body>
</html>