-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathindex.html
More file actions
458 lines (381 loc) · 20.8 KB
/
index.html
File metadata and controls
458 lines (381 loc) · 20.8 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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>Users guide — Matplotlib 3.6.0rc1 documentation</title>
<script>
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "light"
</script>
<!-- Loaded before other Sphinx assets -->
<link href="../_static/styles/theme.css?digest=92025949c220c2e29695" rel="stylesheet">
<link href="../_static/styles/pydata-sphinx-theme.css?digest=92025949c220c2e29695" rel="stylesheet">
<link rel="stylesheet"
href="../_static/vendor/fontawesome/5.13.0/css/all.min.css">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/css/style.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/sg_gallery.css" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-dataframe.css" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-rendered-html.css" />
<link rel="stylesheet" type="text/css" href="../_static/design-style.b7bb847fb20b106c3d81b95245e65545.min.css" />
<link rel="stylesheet" type="text/css" href="../_static/mpl.css?v3.6.0rc1-4-gf7130cd5c7" />
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=92025949c220c2e29695">
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/clipboard.min.js"></script>
<script src="../_static/copybutton.js"></script>
<script src="../_static/design-tabs.js"></script>
<script async="async" src="https://www.google-analytics.com/analytics.js"></script>
<script>
window.ga = window.ga || function () {
(ga.q = ga.q || []).push(arguments) };
ga.l = +new Date;
ga('create', 'UA-55954603-1', 'auto');
ga('set', 'anonymizeIp', true);
ga('send', 'pageview');
</script>
<link rel="canonical" href="https://matplotlib.org/stable/users/index.html" />
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.6.0rc1 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Getting started" href="getting_started/index.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en">
</head>
<body data-spy="scroll" data-target="#bd-toc-nav" data-offset="180" data-default-mode="">
<div class="bd-header-announcement container-fluid" id="banner">
</div>
<nav class="bd-header navbar navbar-light navbar-expand-lg bg-light fixed-top bd-navbar" id="navbar-main"><div class="bd-header__inner container-xl">
<div id="navbar-start">
<a class="navbar-brand" href="#">
<img src="../_static/logo2.svg" class="logo" alt="logo">
</a>
</div>
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar-collapsible" aria-controls="navbar-collapsible" aria-expanded="false" aria-label="Toggle navigation">
<span class="fas fa-bars"></span>
</button>
<div id="navbar-collapsible" class="col-lg-9 collapse navbar-collapse">
<div id="navbar-center" class="mr-auto">
<div class="navbar-center-item">
<ul id="navbar-main-elements" class="navbar-nav">
<li class="nav-item">
<a class="reference internal nav-link" href="../plot_types/index.html">Plot types</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../gallery/index.html">Examples</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../tutorials/index.html">Tutorials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../api/index.html">Reference</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="#">User guide</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../devel/index.html">Develop</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="release_notes.html">Release notes</a>
</li>
</ul>
</div>
</div>
<div id="navbar-end">
<div class="navbar-end-item">
<div class="dropdown" id="version_switcher">
<button type="button" class="btn btn-sm navbar-btn dropdown-toggle" id="version_switcher_button" data-toggle="dropdown">
devdocs <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div id="version_switcher_menu" class="dropdown-menu list-group-flush py-0" aria-labelledby="version_switcher_button">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div>
<!-- NOTE: this JS must live here (not in our global JS file) because it relies
on being processed by Jinja before it is run (specifically for replacing
variables users/index and {'json_url': 'https://matplotlib.org/devdocs/_static/switcher.json', 'version_match': 'devdocs'}.
-->
<script type="text/javascript">
// Check if corresponding page path exists in other version of docs
// and, if so, go there instead of the homepage of the other docs version
function checkPageExistsAndRedirect(event) {
const currentFilePath = "users/index.html",
tryUrl = event.target.getAttribute("href");
let otherDocsHomepage = tryUrl.replace(currentFilePath, "");
$.ajax({
type: 'HEAD',
url: tryUrl,
// if the page exists, go there
success: function() {
location.href = tryUrl;
}
}).fail(function() {
location.href = otherDocsHomepage;
});
// this prevents the browser from following the href of the clicked node
// (which is fine because this function takes care of redirecting)
return false;
}
// Populate the version switcher from the JSON config file
(function () {
$.getJSON("https://matplotlib.org/devdocs/_static/switcher.json", function(data, textStatus, jqXHR) {
const currentFilePath = "users/index.html";
let btn = document.getElementById("version_switcher_button");
// Set empty strings by default so that these attributes exist and can be used in CSS selectors
btn.dataset["activeVersionName"] = "";
btn.dataset["activeVersion"] = "";
// create links to the corresponding page in the other docs versions
$.each(data, function(index, entry) {
// if no custom name specified (e.g., "latest"), use version string
if (!("name" in entry)) {
entry.name = entry.version;
}
// create the node
const node = document.createElement("a");
node.setAttribute("class", "list-group-item list-group-item-action py-1");
node.textContent = `${entry.name}`;
node.setAttribute("href", `${entry.url}${currentFilePath}`);
// on click, AJAX calls will check if the linked page exists before
// trying to redirect, and if not, will redirect to the homepage
// for that version of the docs.
node.onclick = checkPageExistsAndRedirect;
// Add dataset values for the version and name in case people want
// to apply CSS styling based on this information.
node.dataset["versionName"] = entry.name;
node.dataset["version"] = entry.version;
$("#version_switcher_menu").append(node);
// replace dropdown button text with the preferred display name of
// this version, rather than using sphinx's 3.6.0rc1 variable.
// also highlight the dropdown entry for the currently-viewed
// version's entry
if (entry.version == "devdocs") {
node.classList.add("active");
btn.innerText = btn.dataset["activeVersionName"] = entry.name;
btn.dataset["activeVersion"] = entry.version;
}
});
});
})();
</script>
</div>
<div class="navbar-end-item">
<ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
<li class="nav-item">
<a class="nav-link" href="https://gitter.im/matplotlib" rel="noopener" target="_blank" title="gitter">
<span><i class="fab fa-gitter"></i></span>
<label class="sr-only">gitter</label>
</a>
</li>
<li class="nav-item">
<a class="nav-link" href="https://discourse.matplotlib.org" rel="noopener" target="_blank" title="discourse">
<span><i class="fab fa-discourse"></i></span>
<label class="sr-only">discourse</label>
</a>
</li>
<li class="nav-item">
<a class="nav-link" href="https://github.com/matplotlib/matplotlib" rel="noopener" target="_blank" title="GitHub">
<span><i class="fab fa-github-square"></i></span>
<label class="sr-only">GitHub</label>
</a>
</li>
<li class="nav-item">
<a class="nav-link" href="https://twitter.com/matplotlib/" rel="noopener" target="_blank" title="twitter">
<span><i class="fab fa-twitter-square"></i></span>
<label class="sr-only">twitter</label>
</a>
</li>
</ul>
</div>
<div class="navbar-end-item">
<span id="theme-switch" class="btn btn-sm btn-outline-primary navbar-btn rounded-circle">
<a class="theme-switch" data-mode="light"><i class="fas fa-sun"></i></a>
<a class="theme-switch" data-mode="dark"><i class="far fa-moon"></i></a>
<a class="theme-switch" data-mode="auto"><i class="fas fa-adjust"></i></a>
</span>
</div>
</div>
</div>
</div>
</nav>
<div class="bd-container container-xl">
<div class="bd-container__inner row">
<!-- Only show if we have sidebars configured, else just a small margin -->
<div class="bd-sidebar-primary col-12 col-md-3 bd-sidebar">
<div class="sidebar-start-items"><form class="bd-search d-flex align-items-center" action="../search.html" method="get">
<i class="icon fas fa-search"></i>
<input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" >
</form><nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
<div class="bd-toc-item active">
</div>
</nav>
</div>
<div class="sidebar-end-items">
</div>
</div>
<div class="bd-sidebar-secondary d-none d-xl-block col-xl-2 bd-toc">
<div class="toc-item">
<div class="tocsection onthispage mt-5 pt-1 pb-3">
<i class="fas fa-list"></i> On this page
</div>
<nav id="bd-toc-nav">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#general">
General
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#tutorials-and-examples">
Tutorials and examples
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#reference">
Reference
</a>
</li>
</ul>
</nav>
</div>
<div class="toc-item">
</div>
</div>
<div class="bd-content col-12 col-md-9 col-xl-7">
<article class="bd-article" role="main">
<section id="users-guide">
<span id="users-guide-index"></span><h1>Users guide<a class="headerlink" href="#users-guide" title="Permalink to this heading">#</a></h1>
<section id="general">
<h2>General<a class="headerlink" href="#general" title="Permalink to this heading">#</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="getting_started/index.html">Getting started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="getting_started/index.html#installation-quick-start">Installation quick-start</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting_started/index.html#draw-a-first-plot">Draw a first plot</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting_started/index.html#where-to-go-next">Where to go next</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="installing/index.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installing/index.html#installing-an-official-release">Installing an official release</a></li>
<li class="toctree-l2"><a class="reference internal" href="installing/index.html#third-party-distributions">Third-party distributions</a></li>
<li class="toctree-l2"><a class="reference internal" href="installing/index.html#installing-a-nightly-build">Installing a nightly build</a></li>
<li class="toctree-l2"><a class="reference internal" href="installing/index.html#installing-from-source">Installing from source</a></li>
<li class="toctree-l2"><a class="reference internal" href="installing/index.html#installing-for-development">Installing for development</a></li>
<li class="toctree-l2"><a class="reference internal" href="installing/index.html#frequently-asked-questions">Frequently asked questions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="explain/index.html">Explanations</a><ul>
<li class="toctree-l2"><a class="reference internal" href="explain/api_interfaces.html">Matplotlib Application Interfaces (APIs)</a></li>
<li class="toctree-l2"><a class="reference internal" href="explain/backends.html">Backends</a></li>
<li class="toctree-l2"><a class="reference internal" href="explain/interactive.html">Interactive figures</a></li>
<li class="toctree-l2"><a class="reference internal" href="explain/fonts.html">Fonts in Matplotlib</a></li>
<li class="toctree-l2"><a class="reference internal" href="explain/event_handling.html">Event handling and picking</a></li>
<li class="toctree-l2"><a class="reference internal" href="explain/performance.html">Performance</a></li>
<li class="toctree-l2"><a class="reference internal" href="explain/interactive_guide.html">Interactive figures and asynchronous programming</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="faq/index.html">How-to and troubleshooting</a><ul>
<li class="toctree-l2"><a class="reference internal" href="faq/howto_faq.html">How-to</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq/troubleshooting_faq.html">Troubleshooting</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq/environment_variables_faq.html">Environment variables</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="resources/index.html">External resources</a><ul>
<li class="toctree-l2"><a class="reference internal" href="resources/index.html#books-chapters-and-articles">Books, chapters and articles</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/index.html#videos">Videos</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/index.html#tutorials">Tutorials</a></li>
</ul>
</li>
</ul>
</div>
</section>
<section id="tutorials-and-examples">
<h2>Tutorials and examples<a class="headerlink" href="#tutorials-and-examples" title="Permalink to this heading">#</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../plot_types/index.html">Plot types</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/index.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../gallery/index.html">Examples</a></li>
</ul>
</div>
</section>
<section id="reference">
<h2>Reference<a class="headerlink" href="#reference" title="Permalink to this heading">#</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api/index.html">API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../api/index.html#usage-patterns">Usage patterns</a></li>
<li class="toctree-l2"><a class="reference internal" href="../api/index.html#modules">Modules</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../devel/index.html">Contributing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../devel/contributing.html">Contributing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../devel/triage.html">Bug triaging and issue curation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../devel/development_setup.html">Setting up Matplotlib for development</a></li>
<li class="toctree-l2"><a class="reference internal" href="../devel/testing.html">Testing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../devel/documenting_mpl.html">Writing documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../devel/style_guide.html">Documentation style guide</a></li>
<li class="toctree-l2"><a class="reference internal" href="../devel/gitwash/index.html">Working with <em>Matplotlib</em> source code</a></li>
<li class="toctree-l2"><a class="reference internal" href="../devel/coding_guide.html">Pull request guidelines</a></li>
<li class="toctree-l2"><a class="reference internal" href="../devel/release_guide.html">Release guide</a></li>
<li class="toctree-l2"><a class="reference internal" href="../devel/dependencies.html">Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="../devel/min_dep_policy.html">Minimum version of dependencies policy</a></li>
<li class="toctree-l2"><a class="reference internal" href="../devel/MEP/index.html">Matplotlib Enhancement Proposals</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="project/index.html">Project information</a><ul>
<li class="toctree-l2"><a class="reference internal" href="project/mission.html">Matplotlib Mission Statement</a></li>
<li class="toctree-l2"><a class="reference internal" href="project/history.html">History</a></li>
<li class="toctree-l2"><a class="reference internal" href="project/citing.html">Citing Matplotlib</a></li>
<li class="toctree-l2"><a class="reference internal" href="project/license.html">License</a></li>
<li class="toctree-l2"><a class="reference internal" href="project/credits.html">Credits</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release notes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="release_notes.html#next-version">Next version</a></li>
<li class="toctree-l2"><a class="reference internal" href="release_notes.html#version-3-5">Version 3.5</a></li>
<li class="toctree-l2"><a class="reference internal" href="release_notes.html#version-3-4">Version 3.4</a></li>
<li class="toctree-l2"><a class="reference internal" href="release_notes.html#past-versions">Past versions</a></li>
</ul>
</li>
</ul>
</div>
</section>
</section>
</article>
</div>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script src="../_static/scripts/pydata-sphinx-theme.js?digest=92025949c220c2e29695"></script>
<footer class="bd-footer"><div class="bd-footer__inner container">
<div class="footer-item">
<p class="copyright">
© Copyright 2002–2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012–2022 The Matplotlib development team.<br>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 5.1.1.<br>
</p>
</div>
</div>
</footer>
</body>
</html>