matplotlib.github.com/3.1.3/devel/plot_directive.html at main · matplotlib/matplotlib.github.com

History

367 lines (329 loc) · 25.6 KB

Raw

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

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>Plot directive documentation — Matplotlib 3.1.3 documentation</title>

type="text/css" />

type="text/css" />

title="Search within Matplotlib 3.1.3 documentation"

href="../_static/opensearch.xml"/>

</head>

<body>

<div id="unreleased-message"> You are reading an old version of the documentation (v3.1.3). For the latest version see <a href="/stable/">https://matplotlib.org/stable/</a> </div>

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px">Version 3.1.3</div>

<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>

</div>

<ul>

<li><a href="../users/installing.html">Installation</a></li>

<li><a href="../contents.html">Documentation</a></li>

<li><a href="../gallery/index.html">Examples</a></li>

<li><a href="../tutorials/index.html">Tutorials</a></li>

<li><a href="index.html">Contributing</a></li>

</form>

</li>

</ul>

</nav>

<h3>Navigation</h3>

<ul>

<a href="../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<a href="add_new_projection.html" title="Developer's guide for creating scales and transformations"

accesskey="N">next</a> |</li>

<a href="documenting_mpl.html" title="Writing documentation"

accesskey="P">previous</a> |</li>

<li><a href="../contents.html">contents</a> »</li>

<li><a href="index.html" accesskey="U">The Matplotlib Developers' Guide</a> »</li>

</ul>

</div>

<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>

<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>

</div>

<div id="sidebar-pagesource" role="note" aria-label="source link"

style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">

<a href="../_sources/devel/plot_directive.rst.txt"

style="color: #c0c0c0" rel="nofollow">Show Page Source</a>

</div>

<h1>Plot directive documentation<a class="headerlink" href="#module-matplotlib.sphinxext.plot_directive" title="Permalink to this headline">¶</a></h1>

A directive for including a matplotlib plot in a Sphinx document.

By default, in HTML output, <code class="xref py py-obj docutils literal notranslate">plot</code> will include a .png file with a

link to a high-res .png and .pdf. In LaTeX output, it will include a

.pdf.

The source code for the plot may be included in one of three ways:

<li>A path to a source file as the argument to the directive:

<div class="highlight-default notranslate"><div class="highlight"><pre>.. plot:: path/to/plot.py

</pre></div>

</div>

When a path to a source file is given, the content of the

directive may optionally contain a caption for the plot:

This is the caption for the plot

</pre></div>

</div>

Additionally, one may specify the name of a function to call (with

no arguments) immediately after importing the module:

</pre></div>

</div>

</li>

<li>Included as inline content to the directive:

<div class="highlight-default notranslate"><div class="highlight"><pre>.. plot::

import matplotlib.pyplot as plt

import matplotlib.image as mpimg

import numpy as np

img = mpimg.imread('_static/stinkbug.png')

imgplot = plt.imshow(img)

</pre></div>

</div>

</li>

<li>Using doctest syntax:

<div class="highlight-default notranslate"><div class="highlight"><pre>.. plot::

A plotting example:

>>> import matplotlib.pyplot as plt

>>> plt.plot([1,2,3], [4,5,6])

</pre></div>

</div>

</li>

</ol>

</div></blockquote>

<h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>

The <code class="docutils literal notranslate">plot</code> directive supports the following options:

<dt>format : {'python', 'doctest'}</dt>

<dd>Specify the format of the input</dd>

<dt>include-source : bool</dt>

<dd>Whether to display the source code. The default can be changed

using the <code class="xref py py-obj docutils literal notranslate">plot_include_source</code> variable in conf.py</dd>

<dt>encoding : str</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">:encoding:</code> option.

The encoding will not be inferred using the <code class="docutils literal notranslate">-*- coding -*-</code>

metacomment.</dd>

<dt>context : bool or str</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">:context:</code> option was

specified. This only applies to inline code plot directives,

not those run from files. If the <code class="docutils literal notranslate">:context: reset</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">:context:close-figs</code> keeps the context but closes previous figures

before running the code.</dd>

<dt>nofigs : bool</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">:context:</code>

option.</dd>

</dl>

</div></blockquote>

Additionally, this directive supports all of the options of the

<code class="xref py py-obj docutils literal notranslate">image</code> directive, except for <code class="xref py py-obj docutils literal notranslate">target</code> (since plot will add its own

target). These include <code class="xref py py-obj docutils literal notranslate">alt</code>, <code class="xref py py-obj docutils literal notranslate">height</code>, <code class="xref py py-obj docutils literal notranslate">width</code>, <code class="xref py py-obj docutils literal notranslate">scale</code>, <code class="xref py py-obj docutils literal notranslate">align</code> and

<code class="xref py py-obj docutils literal notranslate">class</code>.

</div>

<h2>Configuration options<a class="headerlink" href="#configuration-options" title="Permalink to this headline">¶</a></h2>

The plot directive has the following configuration options:

<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>

<dd>Code that should be executed before each plot. If not specified or None

it will default to a string containing:

<div class="last highlight-default notranslate"><div class="highlight"><pre>import numpy as np

from matplotlib import pyplot as plt

</pre></div>

</div>

</dd>

<dt>plot_basedir</dt>

<dd>Base directory, to which <code class="docutils literal notranslate">plot::</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>File formats to generate. List of tuples or strings:

<div class="highlight-default notranslate"><div class="highlight"><pre>[(suffix, dpi), suffix, ...]

</pre></div>

</div>

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, ....

</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">context</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.8)"><code class="xref py py-obj docutils literal notranslate">sys.path</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.8)"><code class="xref py py-obj docutils literal notranslate">sys.path</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>

class <code class="descclassname">matplotlib.sphinxext.plot_directive.</code><code class="descname">PlotDirective</code>(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)<a class="reference internal" href="../_modules/matplotlib/sphinxext/plot_directive.html#PlotDirective">[source]</a><a class="headerlink" href="#matplotlib.sphinxext.plot_directive.PlotDirective" title="Permalink to this definition">¶</a></dt>

<dd>Implementation of the <code class="docutils literal notranslate">.. plot::</code> directive.

See the module docstring for details.

<code class="descname">run</code>(self)<a class="reference internal" href="../_modules/matplotlib/sphinxext/plot_directive.html#PlotDirective.run">[source]</a><a class="headerlink" href="#matplotlib.sphinxext.plot_directive.PlotDirective.run" title="Permalink to this definition">¶</a></dt>

<dd>Run the plot directive.

</dd></dl>

exception <code class="descclassname">matplotlib.sphinxext.plot_directive.</code><code class="descname">PlotError</code><a class="reference internal" href="../_modules/matplotlib/sphinxext/plot_directive.html#PlotError">[source]</a><a class="headerlink" href="#matplotlib.sphinxext.plot_directive.PlotError" title="Permalink to this definition">¶</a></dt>

<code class="descclassname">matplotlib.sphinxext.plot_directive.</code><code class="descname">mark_plot_labels</code>(app, document)<a class="reference internal" href="../_modules/matplotlib/sphinxext/plot_directive.html#mark_plot_labels">[source]</a><a class="headerlink" href="#matplotlib.sphinxext.plot_directive.mark_plot_labels" title="Permalink to this definition">¶</a></dt>

<dd>To make plots referenceable, we need to move the reference from

the "htmlonly" (or "latexonly") node to the actual figure node

itself.

</dd></dl>

<code class="descclassname">matplotlib.sphinxext.plot_directive.</code><code class="descname">out_of_date</code>(original, derived)<a class="reference internal" href="../_modules/matplotlib/sphinxext/plot_directive.html#out_of_date">[source]</a><a class="headerlink" href="#matplotlib.sphinxext.plot_directive.out_of_date" title="Permalink to this definition">¶</a></dt>

<dd>Return whether derived is out-of-date relative to original, both of

which are full file paths.

</dd></dl>

<code class="descclassname">matplotlib.sphinxext.plot_directive.</code><code class="descname">plot_directive</code>(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)<a class="reference internal" href="../_modules/matplotlib/sphinxext/plot_directive.html#plot_directive">[source]</a><a class="headerlink" href="#matplotlib.sphinxext.plot_directive.plot_directive" title="Permalink to this definition">¶</a></dt>

<dd>[Deprecated] Implementation of the <code class="docutils literal notranslate">.. plot::</code> directive.

See the module docstring for details.

Notes

Deprecated since version 3.1.

</div>

</dd></dl>

<code class="descclassname">matplotlib.sphinxext.plot_directive.</code><code class="descname">remove_coding</code>(text)<a class="reference internal" href="../_modules/matplotlib/sphinxext/plot_directive.html#remove_coding">[source]</a><a class="headerlink" href="#matplotlib.sphinxext.plot_directive.remove_coding" title="Permalink to this definition">¶</a></dt>

<dd>Remove the coding comment, which six.exec_ doesn't like.

</dd></dl>

<code class="descclassname">matplotlib.sphinxext.plot_directive.</code><code class="descname">render_figures</code>(code, code_path, output_dir, output_base, context, function_name, config, context_reset=False, close_figs=False)<a class="reference internal" href="../_modules/matplotlib/sphinxext/plot_directive.html#render_figures">[source]</a><a class="headerlink" href="#matplotlib.sphinxext.plot_directive.render_figures" title="Permalink to this definition">¶</a></dt>

<dd>Run a pyplot script and save the images in output_dir.

Save the images under output_dir with file names derived from

output_base

</dd></dl>

<code class="descclassname">matplotlib.sphinxext.plot_directive.</code><code class="descname">run_code</code>(code, code_path, ns=None, function_name=None)<a class="reference internal" href="../_modules/matplotlib/sphinxext/plot_directive.html#run_code">[source]</a><a class="headerlink" href="#matplotlib.sphinxext.plot_directive.run_code" title="Permalink to this definition">¶</a></dt>

<dd>Import a Python module from a path, and run the function given by

name, if function_name is not None.

</dd></dl>

<code class="descclassname">matplotlib.sphinxext.plot_directive.</code><code class="descname">split_code_at_show</code>(text)<a class="reference internal" href="../_modules/matplotlib/sphinxext/plot_directive.html#split_code_at_show">[source]</a><a class="headerlink" href="#matplotlib.sphinxext.plot_directive.split_code_at_show" title="Permalink to this definition">¶</a></dt>

<dd>Split code at plt.show().

</dd></dl>

<code class="descclassname">matplotlib.sphinxext.plot_directive.</code><code class="descname">unescape_doctest</code>(text)<a class="reference internal" href="../_modules/matplotlib/sphinxext/plot_directive.html#unescape_doctest">[source]</a><a class="headerlink" href="#matplotlib.sphinxext.plot_directive.unescape_doctest" title="Permalink to this definition">¶</a></dt>

<dd>Extract code from a piece of text, which contains either Python code

or doctests.

</dd></dl>

</div>

</div>

Last updated on Feb 09, 2020.

Created using

<a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.

Doc version v3.1.3-2-g782f6ef56.

</div>

</body>

</footer>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

plot_directive.html

Latest commit

History

plot_directive.html

File metadata and controls