-
Notifications
You must be signed in to change notification settings - Fork 6
Expand file tree
/
Copy pathdocumenting_mpl.html
More file actions
1014 lines (940 loc) · 72 KB
/
documenting_mpl.html
File metadata and controls
1014 lines (940 loc) · 72 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
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!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="Content-Type" content="text/html; charset=utf-8" />
<title>Developer’s tips for documenting matplotlib — Matplotlib 2.0.2.post4416.dev0+g1df513f documentation</title>
<link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
<link rel="stylesheet" href="../_static/gallery.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.0.2.post4416.dev0+g1df513f',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 2.0.2.post4416.dev0+g1df513f 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="top" title="Matplotlib 2.0.2.post4416.dev0+g1df513f documentation" href="../index.html" />
<link rel="up" title="The Matplotlib Developers’ Guide" href="index.html" />
<link rel="next" title="Developer’s guide for creating scales and transformations" href="add_new_projection.html" />
<link rel="prev" title="Developer’s tips for testing" href="testing.html" />
</head>
<body>
<!-- The "Fork me on github" ribbon -->
<img style="float: right; margin-bottom: -40px; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" usemap="#ribbonmap"/>
<map name="ribbonmap">
<area shape="poly" coords="15,0,148,-1,148,135" href="https://github.com/matplotlib/matplotlib" title="Fork me on GitHub" />
</map>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="../index.html"><img src="../_static/logo2.svg" width="540px" border="0" alt="matplotlib"/></a>
</div>
<div class="related">
<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="add_new_projection.html" title="Developer’s guide for creating scales and transformations"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="testing.html" title="Developer’s tips for testing"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../gallery/index.html">examples</a>| </li>
<li><a href="../tutorials/index.html">tutorials</a>| </li>
<li><a href="../api/pyplot_summary.html">pyplot</a>| </li>
<li><a href="../contents.html">docs</a> »</li>
<li><a href="index.html" accesskey="U">The Matplotlib Developers’ Guide</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper"><a href="https://www.numfocus.org">
<image src="https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A">
</a>
<br/>
<a href="http://depsy.org/package/python/matplotlib">
<img src="../_static/depsy_badge.svg">
</a>
<br/>
Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">
<img src="https://travis-ci.org/matplotlib/matplotlib.svg?branch=master"/>
</a>
<br/>
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Developer’s tips for documenting matplotlib</a><ul>
<li><a class="reference internal" href="#getting-started">Getting started</a><ul>
<li><a class="reference internal" href="#installing-dependencies">Installing dependencies</a></li>
<li><a class="reference internal" href="#general-structure">General structure</a></li>
<li><a class="reference internal" href="#building-the-docs">Building the docs</a></li>
</ul>
</li>
<li><a class="reference internal" href="#organization-of-matplotlib-s-documentation">Organization of matplotlib’s documentation</a><ul>
<li><a class="reference internal" href="#docstrings">docstrings</a></li>
</ul>
</li>
<li><a class="reference internal" href="#formatting">Formatting</a></li>
<li><a class="reference internal" href="#figures">Figures</a><ul>
<li><a class="reference internal" href="#dynamically-generated-figures">Dynamically generated figures</a><ul>
<li><a class="reference internal" href="#module-matplotlib.sphinxext.plot_directive">Plot directive documentation</a><ul>
<li><a class="reference internal" href="#options">Options</a></li>
<li><a class="reference internal" href="#configuration-options">Configuration options</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#static-figures">Static figures</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#animations">Animations</a></li>
</ul>
</li>
<li><a class="reference internal" href="#referring-to-mpl-documents">Referring to mpl documents</a></li>
<li><a class="reference internal" href="#internal-section-references">Internal section references</a></li>
<li><a class="reference internal" href="#section-names-etc">Section names, etc</a></li>
<li><a class="reference internal" href="#inheritance-diagrams">Inheritance diagrams</a></li>
<li><a class="reference internal" href="#emacs-helpers">Emacs helpers</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">The Matplotlib Developers’ Guide</a><ul>
<li>Previous: <a href="testing.html" title="previous chapter">Developer’s tips for testing</a></li>
<li>Next: <a href="add_new_projection.html" title="next chapter">Developer’s guide for creating scales and transformations</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/devel/documenting_mpl.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="developer-s-tips-for-documenting-matplotlib">
<span id="documenting-matplotlib"></span><h1>Developer’s tips for documenting matplotlib<a class="headerlink" href="#developer-s-tips-for-documenting-matplotlib" title="Permalink to this headline">¶</a></h1>
<div class="section" id="getting-started">
<h2>Getting started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h2>
<div class="section" id="installing-dependencies">
<h3>Installing dependencies<a class="headerlink" href="#installing-dependencies" title="Permalink to this headline">¶</a></h3>
<p>The documentation for matplotlib is generated from reStructuredText using the
<a class="reference external" href="http://www.sphinx-doc.org">Sphinx</a> documentation generation tool. There are several extra requirements that
are needed to build the documentation. They are listed in the file
<a class="reference external" href="https://github.com/matplotlib/matplotlib/blob/master/doc-requirements.txt">doc-requirements.txt</a>
as well as listed below:</p>
<ol class="arabic simple">
<li>Sphinx-1.3 or later(Version 1.5.0 is not supported)</li>
<li>numpydoc 0.4 or later</li>
<li>IPython</li>
<li>Mock</li>
<li>colorspacious</li>
<li>pillow</li>
<li>graphviz</li>
</ol>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<ul class="last simple">
<li>You’ll need a minimal working LaTeX distribution for many examples to run.</li>
<li><a class="reference external" href="http://www.graphviz.org/Download.php">Graphviz</a> is not a python package, and needs
to be installed separately.</li>
</ul>
</div>
</div>
<div class="section" id="general-structure">
<h3>General structure<a class="headerlink" href="#general-structure" title="Permalink to this headline">¶</a></h3>
<p>All documentation is built from the <code class="file docutils literal"><span class="pre">doc/</span></code> directory. This directory contains both
<code class="docutils literal"><span class="pre">.rst</span></code> files that contain pages in the documentation, directories that contain more
<code class="docutils literal"><span class="pre">.rst</span></code> files, and configuration files for <a class="reference external" href="http://www.sphinx-doc.org">Sphinx</a>.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">An exception to this are the directories <code class="file docutils literal"><span class="pre">gallery</span></code> and <code class="file docutils literal"><span class="pre">tutorials</span></code>, which
exist in the root directory. These contain Python files that are built by <a class="reference external" href="https://sphinx-gallery.readthedocs.io/en/latest/">Sphinx Gallery</a>.
When the docs are built, directories of the same name will be generated inside of <code class="file docutils literal"><span class="pre">docs/</span></code>.
The generated directories <code class="file docutils literal"><span class="pre">docs/gallery</span></code> and <code class="file docutils literal"><span class="pre">docs/tutorials</span></code> can be safely deleted.</p>
</div>
<p>The configuration file for Sphinx is <code class="file docutils literal"><span class="pre">doc/conf.py</span></code>. It controls which directories
Sphinx parses, how the docs are built, and how the extensions are used.</p>
</div>
<div class="section" id="building-the-docs">
<h3>Building the docs<a class="headerlink" href="#building-the-docs" title="Permalink to this headline">¶</a></h3>
<p>The documentation sources are found in the <code class="file docutils literal"><span class="pre">doc/</span></code> directory in
the trunk. To build the users guide in html format, cd into
<code class="file docutils literal"><span class="pre">doc/</span></code> and do:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">make</span><span class="o">.</span><span class="n">py</span> <span class="n">html</span>
</pre></div>
</div>
<p>or:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">./</span><span class="n">make</span><span class="o">.</span><span class="n">py</span> <span class="n">html</span>
</pre></div>
</div>
<p>There are many other flags you can pass to <code class="docutils literal"><span class="pre">make.py</span></code>, and you can see the
full list inside that file. Here are two useful ones:</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">clean</span></code> will delete the built Sphinx files. Use this command if you’re getting strange
errors about missing paths or broken links, particularly if you move files around.</li>
<li><code class="docutils literal"><span class="pre">latex</span></code> builds a PDF of the documentation.</li>
</ul>
<p>In addition, these are useful flags:</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">--help</span></code> will (among other things) display the allowed commands for <code class="docutils literal"><span class="pre">make.py</span></code>.</li>
<li><code class="docutils literal"><span class="pre">--allowsphinxwarnings</span></code> will allow the docs to continue building even if Sphinx
throws a warning. This is useful for debugging and spot-checking many warnings
at once.</li>
</ul>
</div>
</div>
<div class="section" id="organization-of-matplotlib-s-documentation">
<h2>Organization of matplotlib’s documentation<a class="headerlink" href="#organization-of-matplotlib-s-documentation" title="Permalink to this headline">¶</a></h2>
<p>The actual ReStructured Text files are kept in <code class="file docutils literal"><span class="pre">doc/users</span></code>,
<code class="file docutils literal"><span class="pre">doc/devel</span></code>, <code class="file docutils literal"><span class="pre">doc/api</span></code> and <code class="file docutils literal"><span class="pre">doc/faq</span></code>. The main entry point is
<code class="file docutils literal"><span class="pre">doc/index.rst</span></code>, which pulls in the <code class="file docutils literal"><span class="pre">index.rst</span></code> file for the users
guide, developers guide, api reference, and faqs. The documentation suite is
built as a single document in order to make the most effective use of cross
referencing, we want to make navigating the Matplotlib documentation as easy as
possible.</p>
<p>Additional files can be added to the various guides by including their base
file name (the .rst extension is not necessary) in the table of contents.
It is also possible to include other documents through the use of an include
statement, such as:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">include</span><span class="p">::</span> <span class="o">../../</span><span class="n">TODO</span>
</pre></div>
</div>
<div class="section" id="docstrings">
<h3>docstrings<a class="headerlink" href="#docstrings" title="Permalink to this headline">¶</a></h3>
<p>In addition to the “narrative” documentation described above,
matplotlib also defines its API reference documentation in docstrings.
For the most part, these are standard Python docstrings, but
matplotlib also includes some features to better support documenting
getters and setters.</p>
<p>Matplotlib uses artist introspection of docstrings to support
properties. All properties that you want to support through <code class="docutils literal"><span class="pre">setp</span></code>
and <code class="docutils literal"><span class="pre">getp</span></code> should have a <code class="docutils literal"><span class="pre">set_property</span></code> and <code class="docutils literal"><span class="pre">get_property</span></code>
method in the <a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-class docutils literal"><span class="pre">Artist</span></code></a> class. Yes, this is
not ideal given python properties or enthought traits, but it is a
historical legacy for now. The setter methods use the docstring with
the ACCEPTS token to indicate the type of argument the method accepts.
e.g., in <a class="reference internal" href="../api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D" title="matplotlib.lines.Line2D"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.lines.Line2D</span></code></a>:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># in lines.py</span>
<span class="k">def</span> <span class="nf">set_linestyle</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">linestyle</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Set the linestyle of the line</span>
<span class="sd"> ACCEPTS: [ '-' | '--' | '-.' | ':' | 'steps' | 'None' | ' ' | '' ]</span>
<span class="sd"> """</span>
</pre></div>
</div>
<p>Since matplotlib uses a lot of pass-through <code class="docutils literal"><span class="pre">kwargs</span></code>, e.g., in every
function that creates a line (<a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.plot.html#matplotlib.pyplot.plot" title="matplotlib.pyplot.plot"><code class="xref py py-func docutils literal"><span class="pre">plot()</span></code></a>,
<a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.semilogx.html#matplotlib.pyplot.semilogx" title="matplotlib.pyplot.semilogx"><code class="xref py py-func docutils literal"><span class="pre">semilogx()</span></code></a>,
<a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.semilogy.html#matplotlib.pyplot.semilogy" title="matplotlib.pyplot.semilogy"><code class="xref py py-func docutils literal"><span class="pre">semilogy()</span></code></a>, etc…), it can be difficult for
the new user to know which <code class="docutils literal"><span class="pre">kwargs</span></code> are supported. Matplotlib uses
a docstring interpolation scheme to support documentation of every
function that takes a <code class="docutils literal"><span class="pre">**kwargs</span></code>. The requirements are:</p>
<ol class="arabic simple">
<li>single point of configuration so changes to the properties don’t
require multiple docstring edits.</li>
<li>as automated as possible so that as properties change, the docs
are updated automagically.</li>
</ol>
<p>The function <a class="reference internal" href="../api/_as_gen/matplotlib.artist.kwdoc.html#matplotlib.artist.kwdoc" title="matplotlib.artist.kwdoc"><code class="xref py py-func docutils literal"><span class="pre">matplotlib.artist.kwdoc()</span></code></a> and the decorator
<code class="xref py py-func docutils literal"><span class="pre">matplotlib.docstring.dedent_interpd()</span></code> facilitate this. They combine
python string interpolation in the docstring with the matplotlib
artist introspection facility that underlies <code class="docutils literal"><span class="pre">setp</span></code> and <code class="docutils literal"><span class="pre">getp</span></code>.
The <code class="docutils literal"><span class="pre">kwdoc</span></code> function gives the list of properties as a docstring. In order
to use this in another docstring, first update the
<code class="docutils literal"><span class="pre">matplotlib.docstring.interpd</span></code> object, as seen in this example from
<a class="reference internal" href="../api/lines_api.html#module-matplotlib.lines" title="matplotlib.lines"><code class="xref py py-mod docutils literal"><span class="pre">matplotlib.lines</span></code></a>:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># in lines.py</span>
<span class="n">docstring</span><span class="o">.</span><span class="n">interpd</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">Line2D</span><span class="o">=</span><span class="n">artist</span><span class="o">.</span><span class="n">kwdoc</span><span class="p">(</span><span class="n">Line2D</span><span class="p">))</span>
</pre></div>
</div>
<p>Then in any function accepting <a class="reference internal" href="../api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D" title="matplotlib.lines.Line2D"><code class="xref py py-class docutils literal"><span class="pre">Line2D</span></code></a>
pass-through <code class="docutils literal"><span class="pre">kwargs</span></code>, e.g., <a class="reference internal" href="../api/_as_gen/matplotlib.axes.Axes.plot.html#matplotlib.axes.Axes.plot" title="matplotlib.axes.Axes.plot"><code class="xref py py-meth docutils literal"><span class="pre">matplotlib.axes.Axes.plot()</span></code></a>:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># in axes.py</span>
<span class="nd">@docstring</span><span class="o">.</span><span class="n">dedent_interpd</span>
<span class="k">def</span> <span class="nf">plot</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Some stuff omitted</span>
<span class="sd"> The kwargs are Line2D properties:</span>
<span class="sd"> %(Line2D)s</span>
<span class="sd"> kwargs scalex and scaley, if defined, are passed on</span>
<span class="sd"> to autoscale_view to determine whether the x and y axes are</span>
<span class="sd"> autoscaled; default True. See Axes.autoscale_view for more</span>
<span class="sd"> information</span>
<span class="sd"> """</span>
<span class="k">pass</span>
</pre></div>
</div>
<p>Note there is a problem for <a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-class docutils literal"><span class="pre">Artist</span></code></a>
<code class="docutils literal"><span class="pre">__init__</span></code> methods, e.g., <code class="xref py py-meth docutils literal"><span class="pre">matplotlib.patches.Patch.__init__()</span></code>,
which supports <code class="docutils literal"><span class="pre">Patch</span></code> <code class="docutils literal"><span class="pre">kwargs</span></code>, since the artist inspector cannot
work until the class is fully defined and we can’t modify the
<code class="docutils literal"><span class="pre">Patch.__init__.__doc__</span></code> docstring outside the class definition.
There are some some manual hacks in this case, violating the
“single entry point” requirement above – see the
<code class="docutils literal"><span class="pre">docstring.interpd.update</span></code> calls in <a class="reference internal" href="../api/patches_api.html#module-matplotlib.patches" title="matplotlib.patches"><code class="xref py py-mod docutils literal"><span class="pre">matplotlib.patches</span></code></a>.</p>
</div>
</div>
<div class="section" id="formatting">
<span id="formatting-mpl-docs"></span><h2>Formatting<a class="headerlink" href="#formatting" title="Permalink to this headline">¶</a></h2>
<p>The Sphinx website contains plenty of <a class="reference external" href="http://www.sphinx-doc.org/contents.html">documentation</a> concerning ReST markup and
working with Sphinx in general. Here are a few additional things to keep in mind:</p>
<ul>
<li><p class="first">Please familiarize yourself with the Sphinx directives for <a class="reference external" href="http://www.sphinx-doc.org/markup/inline.html">inline
markup</a>. Matplotlib’s documentation makes heavy use of cross-referencing and
other semantic markup. For example, when referring to external files, use the
<code class="docutils literal"><span class="pre">:file:</span></code> directive.</p>
</li>
<li><p class="first">Function arguments and keywords should be referred to using the <em>emphasis</em>
role. This will keep matplotlib’s documentation consistent with Python’s
documentation:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">Here</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">description</span> <span class="n">of</span> <span class="o">*</span><span class="n">argument</span><span class="o">*</span>
</pre></div>
</div>
<p>Please do not use the <code class="xref py py-obj docutils literal"><span class="pre">default</span> <span class="pre">role</span></code>:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>Please do not describe `argument` like this.
</pre></div>
</div>
<p>nor the <code class="docutils literal"><span class="pre">literal</span></code> role:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>Please do not describe ``argument`` like this.
</pre></div>
</div>
</li>
<li><p class="first">Sphinx does not support tables with column- or row-spanning cells for
latex output. Such tables can not be used when documenting matplotlib.</p>
</li>
<li><p class="first">Mathematical expressions can be rendered as png images in html, and in the
usual way by latex. For example:</p>
<p><code class="docutils literal"><span class="pre">:math:`\sin(x_n^2)`</span></code> yields: <img src="../_images/mathmpl/math-fa85ea0416.png" style="position: relative; bottom: -8px"/>, and:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">math</span><span class="p">::</span>
\<span class="n">int_</span><span class="p">{</span><span class="o">-</span>\<span class="n">infty</span><span class="p">}</span><span class="o">^</span><span class="p">{</span>\<span class="n">infty</span><span class="p">}</span>\<span class="n">frac</span><span class="p">{</span><span class="n">e</span><span class="o">^</span><span class="p">{</span><span class="n">i</span>\<span class="n">phi</span><span class="p">}}{</span><span class="mi">1</span><span class="o">+</span><span class="n">x</span><span class="o">^</span><span class="mi">2</span>\<span class="n">frac</span><span class="p">{</span><span class="n">e</span><span class="o">^</span><span class="p">{</span><span class="n">i</span>\<span class="n">phi</span><span class="p">}}{</span><span class="mi">1</span><span class="o">+</span><span class="n">x</span><span class="o">^</span><span class="mi">2</span><span class="p">}}</span>
</pre></div>
</div>
<p>yields:</p>
<img src="../_images/mathmpl/math-5b4e20db62.png" class="center" /></li>
<li><p class="first">Interactive IPython sessions can be illustrated in the documentation using
the following directive:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">sourcecode</span><span class="p">::</span> <span class="n">ipython</span>
<span class="n">In</span> <span class="p">[</span><span class="mi">69</span><span class="p">]:</span> <span class="n">lines</span> <span class="o">=</span> <span class="n">plot</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">])</span>
</pre></div>
</div>
<p>which would yield:</p>
<div class="highlight-ipython"><div class="highlight"><pre><span></span><span class="gp">In [69]: </span><span class="n">lines</span> <span class="o">=</span> <span class="n">plot</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">])</span>
</pre></div>
</div>
</li>
<li><p class="first">Footnotes <a class="footnote-reference" href="#id2" id="id1">[1]</a> can be added using <code class="docutils literal"><span class="pre">[#]_</span></code>, followed later by:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">rubric</span><span class="p">::</span> <span class="n">Footnotes</span>
<span class="o">..</span> <span class="p">[</span><span class="c1">#]</span>
</pre></div>
</div>
<p class="rubric">Footnotes</p>
<table class="docutils footnote" frame="void" id="id2" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td><p class="first last">For example.</p>
</td></tr>
</tbody>
</table>
</li>
<li><p class="first">Use the <em>note</em> and <em>warning</em> directives, sparingly, to draw attention to
important comments:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">note</span><span class="p">::</span>
<span class="n">Here</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">note</span>
</pre></div>
</div>
<p>yields:</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">here is a note</p>
</div>
<p>also:</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">here is a warning</p>
</div>
</li>
<li><p class="first">Use the <em>deprecated</em> directive when appropriate:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">deprecated</span><span class="p">::</span> <span class="mf">0.98</span>
<span class="n">This</span> <span class="n">feature</span> <span class="ow">is</span> <span class="n">obsolete</span><span class="p">,</span> <span class="n">use</span> <span class="n">something</span> <span class="k">else</span><span class="o">.</span>
</pre></div>
</div>
<p>yields:</p>
<div class="deprecated">
<p><span class="versionmodified">Deprecated since version 0.98: </span>This feature is obsolete, use something else.</p>
</div>
</li>
<li><p class="first">Use the <em>versionadded</em> and <em>versionchanged</em> directives, which have similar
syntax to the <em>deprecated</em> role:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">versionadded</span><span class="p">::</span> <span class="mf">0.98</span>
<span class="n">The</span> <span class="n">transforms</span> <span class="n">have</span> <span class="n">been</span> <span class="n">completely</span> <span class="n">revamped</span><span class="o">.</span>
</pre></div>
</div>
<div class="versionadded">
<p><span class="versionmodified">New in version 0.98: </span>The transforms have been completely revamped.</p>
</div>
</li>
<li><p class="first">Use the <em>seealso</em> directive, for example:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>.. seealso::
Using ReST :ref:`emacs-helpers`:
One example
A bit about :ref:`referring-to-mpl-docs`:
One more
</pre></div>
</div>
<p>yields:</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt>Using ResT <a class="reference internal" href="#emacs-helpers"><span class="std std-ref">Emacs helpers</span></a>:</dt>
<dd><p class="first last">One example</p>
</dd>
<dt>A bit about <a class="reference internal" href="#referring-to-mpl-docs"><span class="std std-ref">Referring to mpl documents</span></a>:</dt>
<dd><p class="first last">One more</p>
</dd>
</dl>
</div>
</li>
<li><p class="first">Please keep the <a class="reference internal" href="../glossary/index.html#glossary"><span class="std std-ref">Glossary</span></a> in mind when writing documentation. You can
create a references to a term in the glossary with the <code class="docutils literal"><span class="pre">:term:</span></code> role.</p>
</li>
<li><p class="first">The autodoc extension will handle index entries for the API, but additional
entries in the <a class="reference external" href="http://www.sphinx-doc.org/markup/para.html#index-generating-markup">index</a> need to be explicitly added.</p>
</li>
<li><p class="first">Please limit the text width of docstrings to 70 characters.</p>
</li>
<li><p class="first">Keyword arguments should be described using a definition list.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">matplotlib makes extensive use of keyword arguments as pass-through
arguments, there are a many cases where a table is used in place of a
definition list for autogenerated sections of docstrings.</p>
</div>
</li>
</ul>
</div>
<div class="section" id="figures">
<h2>Figures<a class="headerlink" href="#figures" title="Permalink to this headline">¶</a></h2>
<div class="section" id="dynamically-generated-figures">
<h3>Dynamically generated figures<a class="headerlink" href="#dynamically-generated-figures" title="Permalink to this headline">¶</a></h3>
<p>Figures can be automatically generated from scripts and included in
the docs. It is not necessary to explicitly save the figure in the
script, this will be done automatically at build time to ensure that
the code that is included runs and produces the advertised figure.</p>
<p>The path should be relative to the <code class="docutils literal"><span class="pre">doc</span></code> directory. Any plots
specific to the documentation should be added to the <code class="docutils literal"><span class="pre">doc/mpl_examples/pyplots</span></code>
directory and committed to git. Plots from the <code class="docutils literal"><span class="pre">examples</span></code> directory
may be referenced through the symlink <code class="docutils literal"><span class="pre">mpl_examples</span></code> in the <code class="docutils literal"><span class="pre">doc</span></code>
directory. e.g.:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">plot</span><span class="p">::</span> <span class="n">mpl_examples</span><span class="o">/</span><span class="n">pylab_examples</span><span class="o">/</span><span class="n">simple_plot</span><span class="o">.</span><span class="n">py</span>
</pre></div>
</div>
<p>The <code class="docutils literal"><span class="pre">:scale:</span></code> directive rescales the image to some percentage of the
original size, though we don’t recommend using this in most cases
since it is probably better to choose the correct figure size and dpi
in mpl and let it handle the scaling.</p>
<div class="section" id="module-matplotlib.sphinxext.plot_directive">
<span id="plot-directive-documentation"></span><h4>Plot directive documentation<a class="headerlink" href="#module-matplotlib.sphinxext.plot_directive" title="Permalink to this headline">¶</a></h4>
<p>A directive for including a matplotlib plot in a Sphinx document.</p>
<p>By default, in HTML output, <code class="xref py py-obj docutils literal"><span class="pre">plot</span></code> will include a .png file with a
link to a high-res .png and .pdf. In LaTeX output, it will include a
.pdf.</p>
<p>The source code for the plot may be included in one of three ways:</p>
<blockquote>
<div><ol class="arabic">
<li><p class="first"><strong>A path to a source file</strong> as the argument to the directive:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">plot</span><span class="p">::</span> <span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">plot</span><span class="o">.</span><span class="n">py</span>
</pre></div>
</div>
<p>When a path to a source file is given, the content of the
directive may optionally contain a caption for the plot:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">plot</span><span class="p">::</span> <span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">plot</span><span class="o">.</span><span class="n">py</span>
<span class="n">This</span> <span class="ow">is</span> <span class="n">the</span> <span class="n">caption</span> <span class="k">for</span> <span class="n">the</span> <span class="n">plot</span>
</pre></div>
</div>
<p>Additionally, one may specify the name of a function to call (with
no arguments) immediately after importing the module:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">plot</span><span class="p">::</span> <span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">plot</span><span class="o">.</span><span class="n">py</span> <span class="n">plot_function1</span>
</pre></div>
</div>
</li>
<li><p class="first">Included as <strong>inline content</strong> to the directive:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">plot</span><span class="p">::</span>
<span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
<span class="kn">import</span> <span class="nn">matplotlib.image</span> <span class="k">as</span> <span class="nn">mpimg</span>
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="n">img</span> <span class="o">=</span> <span class="n">mpimg</span><span class="o">.</span><span class="n">imread</span><span class="p">(</span><span class="s1">'_static/stinkbug.png'</span><span class="p">)</span>
<span class="n">imgplot</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">imshow</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
</pre></div>
</div>
</li>
<li><p class="first">Using <strong>doctest</strong> syntax:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">plot</span><span class="p">::</span>
<span class="n">A</span> <span class="n">plotting</span> <span class="n">example</span><span class="p">:</span>
<span class="o">>>></span> <span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
<span class="o">>>></span> <span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="p">[</span><span class="mi">4</span><span class="p">,</span><span class="mi">5</span><span class="p">,</span><span class="mi">6</span><span class="p">])</span>
</pre></div>
</div>
</li>
</ol>
</div></blockquote>
<div class="section" id="options">
<h5>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal"><span class="pre">plot</span></code> directive supports the following options:</p>
<blockquote>
<div><dl class="docutils">
<dt>format <span class="classifier-delimiter">:</span> <span class="classifier">{‘python’, ‘doctest’}</span></dt>
<dd>Specify the format of the input</dd>
<dt>include-source <span class="classifier-delimiter">:</span> <span class="classifier">bool</span></dt>
<dd>Whether to display the source code. The default can be changed
using the <code class="xref py py-obj docutils literal"><span class="pre">plot_include_source</span></code> variable in conf.py</dd>
<dt>encoding <span class="classifier-delimiter">:</span> <span class="classifier">str</span></dt>
<dd>If this source file is in a non-UTF8 or non-ASCII encoding,
the encoding must be specified using the <code class="xref py py-obj docutils literal"><span class="pre">:encoding:</span></code> option.
The encoding will not be inferred using the <code class="docutils literal"><span class="pre">-*-</span> <span class="pre">coding</span> <span class="pre">-*-</span></code>
metacomment.</dd>
<dt>context <span class="classifier-delimiter">:</span> <span class="classifier">bool or str</span></dt>
<dd>If provided, the code will be run in the context of all
previous plot directives for which the <code class="xref py py-obj docutils literal"><span class="pre">:context:</span></code> option was
specified. This only applies to inline code plot directives,
not those run from files. If the <code class="docutils literal"><span class="pre">:context:</span> <span class="pre">reset</span></code> option is
specified, the context is reset for this and future plots, and
previous figures are closed prior to running the code.
<code class="docutils literal"><span class="pre">:context:close-figs</span></code> keeps the context but closes previous figures
before running the code.</dd>
<dt>nofigs <span class="classifier-delimiter">:</span> <span class="classifier">bool</span></dt>
<dd>If specified, the code block will be run, but no figures will
be inserted. This is usually useful with the <code class="docutils literal"><span class="pre">:context:</span></code>
option.</dd>
</dl>
</div></blockquote>
<p>Additionally, this directive supports all of the options of the
<code class="xref py py-obj docutils literal"><span class="pre">image</span></code> directive, except for <code class="xref py py-obj docutils literal"><span class="pre">target</span></code> (since plot will add its own
target). These include <code class="xref py py-obj docutils literal"><span class="pre">alt</span></code>, <code class="xref py py-obj docutils literal"><span class="pre">height</span></code>, <code class="xref py py-obj docutils literal"><span class="pre">width</span></code>, <code class="xref py py-obj docutils literal"><span class="pre">scale</span></code>, <code class="xref py py-obj docutils literal"><span class="pre">align</span></code> and
<code class="xref py py-obj docutils literal"><span class="pre">class</span></code>.</p>
</div>
<div class="section" id="configuration-options">
<h5>Configuration options<a class="headerlink" href="#configuration-options" title="Permalink to this headline">¶</a></h5>
<p>The plot directive has the following configuration options:</p>
<blockquote>
<div><dl class="docutils">
<dt>plot_include_source</dt>
<dd>Default value for the include-source option</dd>
<dt>plot_html_show_source_link</dt>
<dd>Whether to show a link to the source in HTML.</dd>
<dt>plot_pre_code</dt>
<dd>Code that should be executed before each plot.</dd>
<dt>plot_basedir</dt>
<dd>Base directory, to which <code class="docutils literal"><span class="pre">plot::</span></code> file names are relative
to. (If None or empty, file names are relative to the
directory where the file containing the directive is.)</dd>
<dt>plot_formats</dt>
<dd><p class="first">File formats to generate. List of tuples or strings:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">[(</span><span class="n">suffix</span><span class="p">,</span> <span class="n">dpi</span><span class="p">),</span> <span class="n">suffix</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span>
</pre></div>
</div>
<p class="last">that determine the file format and the DPI. For entries whose
DPI was omitted, sensible defaults are chosen. When passing from
the command line through sphinx_build the list should be passed as
suffix:dpi,suffix:dpi, ….</p>
</dd>
<dt>plot_html_show_formats</dt>
<dd>Whether to show links to the files in HTML.</dd>
<dt>plot_rcparams</dt>
<dd>A dictionary containing any non-standard rcParams that should
be applied before each plot.</dd>
<dt>plot_apply_rcparams</dt>
<dd>By default, rcParams are applied when <code class="xref py py-obj docutils literal"><span class="pre">context</span></code> option is not used in
a plot directive. This configuration option overrides this behavior
and applies rcParams before each plot.</dd>
<dt>plot_working_directory</dt>
<dd>By default, the working directory will be changed to the directory of
the example, so the code can get at its data files, if any. Also its
path will be added to <a class="reference external" href="https://docs.python.org/2/library/sys.html#sys.path" title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">sys.path</span></code></a> so it can import any helper modules
sitting beside it. This configuration option can be used to specify
a central directory (also added to <a class="reference external" href="https://docs.python.org/2/library/sys.html#sys.path" title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">sys.path</span></code></a>) where data files and
helper modules for all code are located.</dd>
<dt>plot_template</dt>
<dd>Provide a customized template for preparing restructured text.</dd>
</dl>
</div></blockquote>
</div>
</div>
</div>
<div class="section" id="static-figures">
<h3>Static figures<a class="headerlink" href="#static-figures" title="Permalink to this headline">¶</a></h3>
<p>Any figures that rely on optional system configurations need to be handled a
little differently. These figures are not to be generated during the
documentation build, in order to keep the prerequisites to the documentation
effort as low as possible. Please run the <code class="file docutils literal"><span class="pre">doc/pyplots/make.py</span></code> script
when adding such figures, and commit the script <strong>and</strong> the images to
git. Please also add a line to the README in doc/pyplots for any additional
requirements necessary to generate a new figure. Once these steps have been
taken, these figures can be included in the usual way:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">plot</span><span class="p">::</span> <span class="n">mpl_examples</span><span class="o">/</span><span class="n">text_labels_and_annotations</span><span class="o">/</span><span class="n">tex_demo</span><span class="o">.</span><span class="n">py</span>
<span class="p">:</span><span class="n">include</span><span class="o">-</span><span class="n">source</span><span class="p">:</span>
</pre></div>
</div>
</div>
<div class="section" id="examples">
<h3>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h3>
<p>The source of the files in the <code class="docutils literal"><span class="pre">examples</span></code> directory are
automatically included in the HTML docs. An image is generated and
included for all examples in the <code class="docutils literal"><span class="pre">api</span></code> and <code class="docutils literal"><span class="pre">pylab_examples</span></code>
directories. To exclude the example from having an image rendered,
insert the following special comment anywhere in the script:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># -*- noplot -*-</span>
</pre></div>
</div>
</div>
<div class="section" id="animations">
<h3>Animations<a class="headerlink" href="#animations" title="Permalink to this headline">¶</a></h3>
<p>We have a matplotlib google/gmail account with username <code class="docutils literal"><span class="pre">mplgithub</span></code>
which we used to setup the github account but can be used for other
purposes, like hosting google docs or youtube videos. You can embed a
matplotlib animation in the docs by first saving the animation as a
movie using <a class="reference internal" href="../api/_as_gen/matplotlib.animation.Animation.save.html#matplotlib.animation.Animation.save" title="matplotlib.animation.Animation.save"><code class="xref py py-meth docutils literal"><span class="pre">matplotlib.animation.Animation.save()</span></code></a>, and then
uploading to <a class="reference external" href="https://www.youtube.com/user/matplotlib">matplotlib’s youtube
channel</a> and inserting the
embedding string youtube provides like:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">raw</span><span class="p">::</span> <span class="n">html</span>
<span class="o"><</span><span class="n">iframe</span> <span class="n">width</span><span class="o">=</span><span class="s2">"420"</span> <span class="n">height</span><span class="o">=</span><span class="s2">"315"</span>
<span class="n">src</span><span class="o">=</span><span class="s2">"http://www.youtube.com/embed/32cjc6V0OZY"</span>
<span class="n">frameborder</span><span class="o">=</span><span class="s2">"0"</span> <span class="n">allowfullscreen</span><span class="o">></span>
<span class="o"></</span><span class="n">iframe</span><span class="o">></span>
</pre></div>
</div>
<p>An example save command to generate a movie looks like this</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">ani</span> <span class="o">=</span> <span class="n">animation</span><span class="o">.</span><span class="n">FuncAnimation</span><span class="p">(</span><span class="n">fig</span><span class="p">,</span> <span class="n">animate</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">y</span><span class="p">)),</span>
<span class="n">interval</span><span class="o">=</span><span class="mi">25</span><span class="p">,</span> <span class="n">blit</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">init_func</span><span class="o">=</span><span class="n">init</span><span class="p">)</span>
<span class="n">ani</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="s1">'double_pendulum.mp4'</span><span class="p">,</span> <span class="n">fps</span><span class="o">=</span><span class="mi">15</span><span class="p">)</span>
</pre></div>
</div>
<p>Contact Michael Droettboom for the login password to upload youtube videos of
google docs to the mplgithub account.</p>
</div>
</div>
<div class="section" id="referring-to-mpl-documents">
<span id="referring-to-mpl-docs"></span><h2>Referring to mpl documents<a class="headerlink" href="#referring-to-mpl-documents" title="Permalink to this headline">¶</a></h2>
<p>In the documentation, you may want to include to a document in the
matplotlib src, e.g., a license file or an image file from <code class="xref py py-obj docutils literal"><span class="pre">mpl-data</span></code>,
refer to it via a relative path from the document where the rst file
resides, e.g., in <code class="file docutils literal"><span class="pre">users/navigation_toolbar.rst</span></code>, we refer to the
image icons with:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">image</span><span class="p">::</span> <span class="o">../../</span><span class="n">lib</span><span class="o">/</span><span class="n">matplotlib</span><span class="o">/</span><span class="n">mpl</span><span class="o">-</span><span class="n">data</span><span class="o">/</span><span class="n">images</span><span class="o">/</span><span class="n">subplots</span><span class="o">.</span><span class="n">png</span>
</pre></div>
</div>
<p>In the <code class="xref py py-obj docutils literal"><span class="pre">users</span></code> subdirectory, if I want to refer to a file in the mpl-data
directory, I use the symlink directory. For example, from
<code class="xref py py-obj docutils literal"><span class="pre">customizing.rst</span></code>:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">literalinclude</span><span class="p">::</span> <span class="o">../../</span><span class="n">lib</span><span class="o">/</span><span class="n">matplotlib</span><span class="o">/</span><span class="n">mpl</span><span class="o">-</span><span class="n">data</span><span class="o">/</span><span class="n">matplotlibrc</span>
</pre></div>
</div>
<p>One exception to this is when referring to the examples dir. Relative
paths are extremely confusing in the sphinx plot extensions, so
without getting into the dirty details, it is easier to simply include
a symlink to the files at the top doc level directory. This way, API
documents like <a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.plot.html#matplotlib.pyplot.plot" title="matplotlib.pyplot.plot"><code class="xref py py-meth docutils literal"><span class="pre">matplotlib.pyplot.plot()</span></code></a> can refer to the
examples in a known location.</p>
<p>In the top level doc directory we have symlinks pointing to
the mpl <code class="xref py py-obj docutils literal"><span class="pre">examples</span></code>:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">home</span><span class="p">:</span><span class="o">~/</span><span class="n">mpl</span><span class="o">/</span><span class="n">doc</span><span class="o">></span> <span class="n">ls</span> <span class="o">-</span><span class="n">l</span> <span class="n">mpl_</span><span class="o">*</span>
<span class="n">mpl_examples</span> <span class="o">-></span> <span class="o">../</span><span class="n">examples</span>
</pre></div>
</div>
<p>So we can include plots from the examples dir using the symlink:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">plot</span><span class="p">::</span> <span class="n">mpl_examples</span><span class="o">/</span><span class="n">pylab_examples</span><span class="o">/</span><span class="n">simple_plot</span><span class="o">.</span><span class="n">py</span>
</pre></div>
</div>
<p>We used to use a symlink for <code class="file docutils literal"><span class="pre">mpl-data</span></code> too, but the distro
becomes very large on platforms that do not support links (e.g., the font
files are duplicated and large)</p>
</div>
<div class="section" id="internal-section-references">
<span id="internal-section-refs"></span><h2>Internal section references<a class="headerlink" href="#internal-section-references" title="Permalink to this headline">¶</a></h2>
<p>To maximize internal consistency in section labeling and references,
use hyphen separated, descriptive labels for section references, e.g.,:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">_howto</span><span class="o">-</span><span class="n">webapp</span><span class="p">:</span>
</pre></div>
</div>
<p>and refer to it using the standard reference syntax:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>See :ref:`howto-webapp`
</pre></div>
</div>
<p>Keep in mind that we may want to reorganize the contents later, so
let’s avoid top level names in references like <code class="docutils literal"><span class="pre">user</span></code> or <code class="docutils literal"><span class="pre">devel</span></code>
or <code class="docutils literal"><span class="pre">faq</span></code> unless necessary, because for example the FAQ “what is a
backend?” could later become part of the users guide, so the label:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">_what</span><span class="o">-</span><span class="ow">is</span><span class="o">-</span><span class="n">a</span><span class="o">-</span><span class="n">backend</span>
</pre></div>
</div>
<p>is better than:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">_faq</span><span class="o">-</span><span class="n">backend</span>
</pre></div>
</div>
<p>In addition, since underscores are widely used by Sphinx itself, let’s prefer
hyphens to separate words.</p>
</div>
<div class="section" id="section-names-etc">
<h2>Section names, etc<a class="headerlink" href="#section-names-etc" title="Permalink to this headline">¶</a></h2>
<p>For everything but top level chapters, please use <code class="docutils literal"><span class="pre">Upper</span> <span class="pre">lower</span></code> for
section titles, e.g., <code class="docutils literal"><span class="pre">Possible</span> <span class="pre">hangups</span></code> rather than <code class="docutils literal"><span class="pre">Possible</span>
<span class="pre">Hangups</span></code></p>
</div>
<div class="section" id="inheritance-diagrams">
<h2>Inheritance diagrams<a class="headerlink" href="#inheritance-diagrams" title="Permalink to this headline">¶</a></h2>
<p>Class inheritance diagrams can be generated with the
<code class="docutils literal"><span class="pre">inheritance-diagram</span></code> directive. To use it, you provide the
directive with a number of class or module names (separated by
whitespace). If a module name is provided, all classes in that module
will be used. All of the ancestors of these classes will be included
in the inheritance diagram.</p>
<p>A single option is available: <em>parts</em> controls how many of parts in
the path to the class are shown. For example, if <em>parts</em> == 1, the
class <code class="docutils literal"><span class="pre">matplotlib.patches.Patch</span></code> is shown as <code class="docutils literal"><span class="pre">Patch</span></code>. If <em>parts</em>
== 2, it is shown as <code class="docutils literal"><span class="pre">patches.Patch</span></code>. If <em>parts</em> == 0, the full
path is shown.</p>
<p>Example:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">inheritance</span><span class="o">-</span><span class="n">diagram</span><span class="p">::</span> <span class="n">matplotlib</span><span class="o">.</span><span class="n">patches</span> <span class="n">matplotlib</span><span class="o">.</span><span class="n">lines</span> <span class="n">matplotlib</span><span class="o">.</span><span class="n">text</span>
<span class="p">:</span><span class="n">parts</span><span class="p">:</span> <span class="mi">2</span>
</pre></div>
</div>
<img src="../_images/inheritance-dedcc1c71ae54be773d8e45d7e30897709db8581.png" alt="Inheritance diagram of matplotlib.patches, matplotlib.lines, matplotlib.text" usemap="#inheritance03ab0131b5" class="inheritance"/>
<map id="inheritance03ab0131b5" name="inheritance03ab0131b5">
<area shape="rect" id="node1" href="../api/artist_api.html#matplotlib.artist.Artist" target="_top" title="Abstract base class for someone who renders into a" alt="" coords="46,284,134,307"/>
<area shape="rect" id="node2" href="../api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D" target="_top" title="A line - the line can have both a solid linestyle connecting all" alt="" coords="227,237,320,261"/>
<area shape="rect" id="node7" href="../api/_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch" target="_top" title="A patch is a 2D artist with a face color and an edge color." alt="" coords="221,284,326,307"/>
<area shape="rect" id="node25" href="../api/text_api.html#matplotlib.text.Text" target="_top" title="Handle storing and drawing of text in window or data coordinates." alt="" coords="238,538,309,562"/>
<area shape="rect" id="node3" href="../api/_as_gen/matplotlib.lines.VertexSelector.html#matplotlib.lines.VertexSelector" target="_top" title="Manage the callbacks to maintain a list of selected vertices for" alt="" coords="20,237,161,261"/>
<area shape="rect" id="node4" href="../api/_as_gen/matplotlib.patches.Arc.html#matplotlib.patches.Arc" target="_top" title="An elliptical arc.  Because it performs various optimizations, it" alt="" coords="630,5,723,29"/>
<area shape="rect" id="node5" href="../api/_as_gen/matplotlib.patches.Ellipse.html#matplotlib.patches.Ellipse" target="_top" title="A scale-free ellipse." alt="" coords="403,28,513,51"/>
<area shape="rect" id="node10" href="../api/_as_gen/matplotlib.patches.Circle.html#matplotlib.patches.Circle" target="_top" title="A circle patch." alt="" coords="624,51,729,75"/>
<area shape="rect" id="node6" href="../api/_as_gen/matplotlib.patches.Arrow.html#matplotlib.patches.Arrow" target="_top" title="An arrow patch." alt="" coords="405,74,511,98"/>
<area shape="rect" id="node12" href="../api/_as_gen/matplotlib.patches.RegularPolygon.html#matplotlib.patches.RegularPolygon" target="_top" title="A regular polygon patch." alt="" coords="376,120,540,144"/>
<area shape="rect" id="node14" href="../api/_as_gen/matplotlib.patches.FancyArrowPatch.html#matplotlib.patches.FancyArrowPatch" target="_top" title="A fancy arrow patch. It draws an arrow using the :class:`ArrowStyle`." alt="" coords="371,167,545,191"/>
<area shape="rect" id="node17" href="../api/_as_gen/matplotlib.patches.Polygon.html#matplotlib.patches.Polygon" target="_top" title="A general polygon patch." alt="" coords="398,213,518,237"/>
<area shape="rect" id="node18" href="../api/_as_gen/matplotlib.patches.FancyBboxPatch.html#matplotlib.patches.FancyBboxPatch" target="_top" title="Draw a fancy box around a rectangle with lower left at *xy*=(*x*," alt="" coords="373,260,543,284"/>
<area shape="rect" id="node19" href="../api/_as_gen/matplotlib.patches.PathPatch.html#matplotlib.patches.PathPatch" target="_top" title="A general polycurve path patch." alt="" coords="392,306,524,330"/>
<area shape="rect" id="node20" href="../api/_as_gen/matplotlib.patches.Rectangle.html#matplotlib.patches.Rectangle" target="_top" title="Draw a rectangle with lower left at *xy* = (*x*, *y*) with" alt="" coords="393,353,523,376"/>
<area shape="rect" id="node21" href="../api/_as_gen/matplotlib.patches.Shadow.html#matplotlib.patches.Shadow" target="_top" title="patches.Shadow" alt="" coords="398,399,518,423"/>
<area shape="rect" id="node22" href="../api/_as_gen/matplotlib.patches.Wedge.html#matplotlib.patches.Wedge" target="_top" title="Wedge shaped patch." alt="" coords="402,445,514,469"/>
<area shape="rect" id="node23" href="../api/_as_gen/matplotlib.patches.YAArrow.html#matplotlib.patches.YAArrow" target="_top" title="Yet another arrow class." alt="" coords="398,492,518,516"/>
<area shape="rect" id="node8" href="../api/_as_gen/matplotlib.patches.ArrowStyle.html#matplotlib.patches.ArrowStyle" target="_top" title=":class:`ArrowStyle` is a container class which defines several" alt="" coords="22,191,159,215"/>
<area shape="rect" id="node9" href="../api/_as_gen/matplotlib.patches.BoxStyle.html#matplotlib.patches.BoxStyle" target="_top" title=":class:`BoxStyle` is a container class which defines several" alt="" coords="28,144,153,168"/>
<area shape="rect" id="node11" href="../api/_as_gen/matplotlib.patches.CirclePolygon.html#matplotlib.patches.CirclePolygon" target="_top" title="A polygon-approximation of a circle patch." alt="" coords="600,120,753,144"/>
<area shape="rect" id="node13" href="../api/_as_gen/matplotlib.patches.ConnectionPatch.html#matplotlib.patches.ConnectionPatch" target="_top" title="A :class:`~matplotlib.patches.ConnectionPatch` class is to make" alt="" coords="590,167,763,191"/>
<area shape="rect" id="node15" href="../api/_as_gen/matplotlib.patches.ConnectionStyle.html#matplotlib.patches.ConnectionStyle" target="_top" title=":class:`ConnectionStyle` is a container class which defines" alt="" coords="5,98,176,122"/>
<area shape="rect" id="node16" href="../api/_as_gen/matplotlib.patches.FancyArrow.html#matplotlib.patches.FancyArrow" target="_top" title="Like Arrow, but lets you set head width and head height independently." alt="" coords="606,213,747,237"/>
<area shape="rect" id="node24" href="../api/text_api.html#matplotlib.text.Annotation" target="_top" title="text.Annotation" alt="" coords="401,538,515,562"/>
<area shape="rect" id="node27" href="../api/text_api.html#matplotlib.text.TextWithDash" target="_top" title="This is basically a :class:`~matplotlib.text.Text` with a dash" alt="" coords="394,585,522,609"/>
<area shape="rect" id="node26" href="../api/text_api.html#matplotlib.text.OffsetFrom" target="_top" title="Callable helper class for working with `Annotation`" alt="" coords="33,51,147,75"/>
</map>
</div>
<div class="section" id="emacs-helpers">
<span id="id3"></span><h2>Emacs helpers<a class="headerlink" href="#emacs-helpers" title="Permalink to this headline">¶</a></h2>
<p>There is an emacs mode <a class="reference external" href="http://docutils.sourceforge.net/tools/editors/emacs/rst.el">rst.el</a> which
automates many important ReST tasks like building and updating
table-of-contents, and promoting or demoting section headings. Here
is the basic <code class="docutils literal"><span class="pre">.emacs</span></code> configuration:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">(</span><span class="n">require</span> <span class="s1">'rst)</span>
<span class="p">(</span><span class="n">setq</span> <span class="n">auto</span><span class="o">-</span><span class="n">mode</span><span class="o">-</span><span class="n">alist</span>
<span class="p">(</span><span class="n">append</span> <span class="s1">'(("</span><span class="se">\\</span><span class="s1">.txt$" . rst-mode)</span>
<span class="p">(</span><span class="s2">"</span><span class="se">\\</span><span class="s2">.rst$"</span> <span class="o">.</span> <span class="n">rst</span><span class="o">-</span><span class="n">mode</span><span class="p">)</span>
<span class="p">(</span><span class="s2">"</span><span class="se">\\</span><span class="s2">.rest$"</span> <span class="o">.</span> <span class="n">rst</span><span class="o">-</span><span class="n">mode</span><span class="p">))</span> <span class="n">auto</span><span class="o">-</span><span class="n">mode</span><span class="o">-</span><span class="n">alist</span><span class="p">))</span>
</pre></div>
</div>
<p>Some helpful functions:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">C</span><span class="o">-</span><span class="n">c</span> <span class="n">TAB</span> <span class="o">-</span> <span class="n">rst</span><span class="o">-</span><span class="n">toc</span><span class="o">-</span><span class="n">insert</span>
<span class="n">Insert</span> <span class="n">table</span> <span class="n">of</span> <span class="n">contents</span> <span class="n">at</span> <span class="n">point</span>
<span class="n">C</span><span class="o">-</span><span class="n">c</span> <span class="n">C</span><span class="o">-</span><span class="n">u</span> <span class="o">-</span> <span class="n">rst</span><span class="o">-</span><span class="n">toc</span><span class="o">-</span><span class="n">update</span>
<span class="n">Update</span> <span class="n">the</span> <span class="n">table</span> <span class="n">of</span> <span class="n">contents</span> <span class="n">at</span> <span class="n">point</span>
<span class="n">C</span><span class="o">-</span><span class="n">c</span> <span class="n">C</span><span class="o">-</span><span class="n">l</span> <span class="n">rst</span><span class="o">-</span><span class="n">shift</span><span class="o">-</span><span class="n">region</span><span class="o">-</span><span class="n">left</span>
<span class="n">Shift</span> <span class="n">region</span> <span class="n">to</span> <span class="n">the</span> <span class="n">left</span>
<span class="n">C</span><span class="o">-</span><span class="n">c</span> <span class="n">C</span><span class="o">-</span><span class="n">r</span> <span class="n">rst</span><span class="o">-</span><span class="n">shift</span><span class="o">-</span><span class="n">region</span><span class="o">-</span><span class="n">right</span>
<span class="n">Shift</span> <span class="n">region</span> <span class="n">to</span> <span class="n">the</span> <span class="n">right</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2017 The Matplotlib development team.
Last updated on Jul 16, 2017.
Created using <a
href="http://sphinx-doc.org/">Sphinx</a> 1.6.2.
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-55954603-1', 'auto');
ga('send', 'pageview');
</script>
</body>
<footer>
<!--Flipcause Integration v3.0// Flipcause Integration Instructions:
Install the following code block once in the website Header (after <head> tag) -->
<style>
.fc-black_overlay{
display:none; position: fixed; z-index:1000001; top: 0%;left: 0%;width: 100%;height: 100%;
background-color: black; filter: alpha(opacity=50); cursor:pointer; opacity:0.5;
}
.fc-white_content {
opacity:1; display:none; margin-top: -320px; margin-left: -485px; width:970px; height:640px;
position:fixed; top:50%; left:50%; border: none;z-index:1000002;overflow: auto;
}
.fc-main-box{
opacity:1; display:none; margin:15px auto 0 auto; width:930px; position:relative; z-index:1000003;
}
.fc-widget_close{
opacity:1; content:url(http://i1338.photobucket.com/albums/o691/WeCause/X_zpse4a7e538.png);
position:absolute; z-index=1000004; right:-16px; top:-16px; display:block; cursor:pointer;
}
.floating_button{
display: block; margin-top: 0px; margin-left: 0px; width:auto ; height: auto;
position:fixed; z-index:999999; overflow: auto;
}
@keyframes backfadesin {
from { opacity:0; }
to {opacity:.5;}
}
@-moz-keyframes backfadesin {
from { opacity:0; }
to {opacity:.5;}
}
@-webkit-keyframes backfadesin {
from { opacity:0; }
to {opacity:.5;}
}
@-o-keyframes backfadesin {
from { opacity:0; }
to {opacity:.5;}
}
@-ms-keyframes backfadesin {
from { opacity:0; }
to {opacity:.5;}
}
@keyframes fadesin {
0%{ opacity:0; }
50%{ opacity:0; }
75% {opacity: 0; transform: translateY(20px);}
100% {opacity: 1; transform: translateY(0);}
}
@-moz-keyframes fadesin {
0%{ opacity:0; }
50%{ opacity:0; }
75% {opacity: 0; -moz-transform: translateY(20px);}
100% {opacity: 1; -moz-transform: translateY(0);}
}
@-webkit-keyframes fadesin {
0%{ opacity:0; }
50%{ opacity:0; }
75% {opacity: 0; -webkit-transform: translateY(20px);}
100% {opacity: 1; -webkit-transform: translateY(0);}
}
@-o-keyframes fadesin {
0%{ opacity:0; }
50%{ opacity:0; }
75% {opacity: 0; -o-transform: translateY(20px);}
100% {opacity: 1; -o-transform: translateY(0);}
}
@-ms-keyframes fadesin {
0%{ opacity:0; }
50%{ opacity:0; }
75% {opacity: 0; -ms-transform: translateY(20px);}
100% {opacity: 1; -ms-transform: translateY(0);}
}
</style>
<script>
function open_window(cause_id) {
var protocol=String(document.location.protocol);
var new_url;
if( /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent)){
new_url="https://www.flipcause.com/widget/"+cause_id
window.open(new_url);
}
else {
document.getElementById("fc-fade").style.display = "block";
document.getElementById("fc-fade").style.webkitAnimation = "backfadesin 1s";
document.getElementById("fc-fade").style.animation = "backfadesin 1s";
document.getElementById("fc-fade").style.mozAnimation = "backfadesin 1s";
document.getElementById("fc-light").style.display = "block";
document.getElementById("fc-light").style.webkitAnimation = "fadesin 1.5s";
document.getElementById("fc-light").style.animation = "fadesin 1.5s";
document.getElementById("fc-light").style.mozAnimation = "fadesin 1.5s";
document.getElementById("fc-main").style.display = "block";
document.getElementById("fc-main").style.webkitAnimation = "fadesin 1.5s";
document.getElementById("fc-main").style.animation = "fadesin 1.5s";
document.getElementById("fc-main").style.mozAnimation = "fadesin 1.5s";
document.getElementById("fc-close").style.display = "block";
document.getElementById("fc-close").style.webkitAnimation = "fadesin 1.5s";
document.getElementById("fc-close").style.animation = "fadesin 1.5s";
document.getElementById("fc-close").style.mozAnimation = "fadesin 1.5s";
document.getElementById("fc-myFrame").style.display = "block";
document.getElementById("fc-myFrame").style.webkitAnimation = "fadesin 1.5s";
document.getElementById("fc-myFrame").style.animation = "fadesin 1.5s";
document.getElementById("fc-myFrame").style.mozAnimation = "fadesin 1.5s";
document.getElementById("fc-myFrame").src="https://www.flipcause.com/widget/"+cause_id;
}
}
function close_window() {
document.getElementById("fc-fade").style.display="none";
document.getElementById("fc-light").style.display="none";
document.getElementById("fc-main").style.display="none";
document.getElementById("fc-close").style.display="none";
document.getElementById("fc-myFrame").style.display="none";
}