{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathplot_directive.html
More file actions
351 lines (317 loc) · 22 KB
/
Copy pathplot_directive.html
File metadata and controls
351 lines (317 loc) · 22 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
<!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>Plot directive documentation — Matplotlib 2.2.0 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.2.0',
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.2.0 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.2.0 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="Writing documentation" href="documenting_mpl.html" />
<link rel="canonical" href="https://matplotlib.org/3.1.3/devel/plot_directive.html" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head>
<body>
<div id="unreleased-message"> You are reading an old version of the documentation (v2.2.0). For the latest version see <a href="/stable/">https://matplotlib.org/stable/</a> </div>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../index.html">
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 2.2.0</span></div>
<img src="../_static/logo2.png" height="125px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<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="documenting_mpl.html" title="Writing documentation"
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">
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">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>
<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="documenting_mpl.html" title="previous chapter">Writing documentation</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/plot_directive.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</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="module-matplotlib.sphinxext.plot_directive">
<span id="plot-directive-documentation"></span><h1>Plot directive documentation<a class="headerlink" href="#module-matplotlib.sphinxext.plot_directive" title="Permalink to this headline">¶</a></h1>
<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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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">
<h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
<p>The <code class="docutils literal notranslate"><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 notranslate"><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 notranslate"><span class="pre">:encoding:</span></code> option.
The encoding will not be inferred using the <code class="docutils literal notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><span class="pre">image</span></code> directive, except for <code class="xref py py-obj docutils literal notranslate"><span class="pre">target</span></code> (since plot will add its own
target). These include <code class="xref py py-obj docutils literal notranslate"><span class="pre">alt</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">height</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">width</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">scale</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">align</span></code> and
<code class="xref py py-obj docutils literal notranslate"><span class="pre">class</span></code>.</p>
</div>
<div class="section" id="configuration-options">
<h2>Configuration options<a class="headerlink" href="#configuration-options" title="Permalink to this headline">¶</a></h2>
<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><p class="first">Code that should be executed before each plot. If not specified or None
it will default to a string containing:</p>
<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">from</span> <span class="nn">matplotlib</span> <span class="k">import</span> <span class="n">pyplot</span> <span class="k">as</span> <span class="n">plt</span>
</pre></div>
</div>
</dd>
<dt>plot_basedir</dt>
<dd>Base directory, to which <code class="docutils literal notranslate"><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 notranslate"><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 notranslate"><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/3/library/sys.html#sys.path" title="(in Python v3.6)"><code class="xref py py-obj docutils literal notranslate"><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/3/library/sys.html#sys.path" title="(in Python v3.6)"><code class="xref py py-obj docutils literal notranslate"><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>
<dl class="exception">
<dt id="matplotlib.sphinxext.plot_directive.PlotError">
<em class="property">exception </em><code class="descclassname">matplotlib.sphinxext.plot_directive.</code><code class="descname">PlotError</code><a class="headerlink" href="#matplotlib.sphinxext.plot_directive.PlotError" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.sphinxext.plot_directive.mark_plot_labels">
<code class="descclassname">matplotlib.sphinxext.plot_directive.</code><code class="descname">mark_plot_labels</code><span class="sig-paren">(</span><em>app</em>, <em>document</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.sphinxext.plot_directive.mark_plot_labels" title="Permalink to this definition">¶</a></dt>
<dd><p>To make plots referenceable, we need to move the reference from
the “htmlonly” (or “latexonly”) node to the actual figure node
itself.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.sphinxext.plot_directive.out_of_date">
<code class="descclassname">matplotlib.sphinxext.plot_directive.</code><code class="descname">out_of_date</code><span class="sig-paren">(</span><em>original</em>, <em>derived</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.sphinxext.plot_directive.out_of_date" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns True if derivative is out-of-date wrt original,
both of which are full file paths.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.sphinxext.plot_directive.plot_directive">
<code class="descclassname">matplotlib.sphinxext.plot_directive.</code><code class="descname">plot_directive</code><span class="sig-paren">(</span><em>name</em>, <em>arguments</em>, <em>options</em>, <em>content</em>, <em>lineno</em>, <em>content_offset</em>, <em>block_text</em>, <em>state</em>, <em>state_machine</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.sphinxext.plot_directive.plot_directive" title="Permalink to this definition">¶</a></dt>
<dd><p>Implementation of the <code class="docutils literal notranslate"><span class="pre">..</span> <span class="pre">plot::</span></code> directive.</p>
<p>See the module docstring for details.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.sphinxext.plot_directive.remove_coding">
<code class="descclassname">matplotlib.sphinxext.plot_directive.</code><code class="descname">remove_coding</code><span class="sig-paren">(</span><em>text</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.sphinxext.plot_directive.remove_coding" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove the coding comment, which six.exec_ doesn’t like.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.sphinxext.plot_directive.render_figures">
<code class="descclassname">matplotlib.sphinxext.plot_directive.</code><code class="descname">render_figures</code><span class="sig-paren">(</span><em>code</em>, <em>code_path</em>, <em>output_dir</em>, <em>output_base</em>, <em>context</em>, <em>function_name</em>, <em>config</em>, <em>context_reset=False</em>, <em>close_figs=False</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.sphinxext.plot_directive.render_figures" title="Permalink to this definition">¶</a></dt>
<dd><p>Run a pyplot script and save the images in <em>output_dir</em>.</p>
<p>Save the images under <em>output_dir</em> with file names derived from
<em>output_base</em></p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.sphinxext.plot_directive.run_code">
<code class="descclassname">matplotlib.sphinxext.plot_directive.</code><code class="descname">run_code</code><span class="sig-paren">(</span><em>code</em>, <em>code_path</em>, <em>ns=None</em>, <em>function_name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.sphinxext.plot_directive.run_code" title="Permalink to this definition">¶</a></dt>
<dd><p>Import a Python module from a path, and run the function given by
name, if function_name is not None.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.sphinxext.plot_directive.split_code_at_show">
<code class="descclassname">matplotlib.sphinxext.plot_directive.</code><code class="descname">split_code_at_show</code><span class="sig-paren">(</span><em>text</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.sphinxext.plot_directive.split_code_at_show" title="Permalink to this definition">¶</a></dt>
<dd><p>Split code at plt.show()</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.sphinxext.plot_directive.unescape_doctest">
<code class="descclassname">matplotlib.sphinxext.plot_directive.</code><code class="descname">unescape_doctest</code><span class="sig-paren">(</span><em>text</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.sphinxext.plot_directive.unescape_doctest" title="Permalink to this definition">¶</a></dt>
<dd><p>Extract code from a piece of text, which contains either Python code
or doctests.</p>
</dd></dl>
</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 Mar 06, 2018.
Created using <a
href="http://sphinx-doc.org/">Sphinx</a> 1.7.1.
</div>
</body>
<footer>
</footer>
</html>
You can’t perform that action at this time.