`matplotlib.sphinxext.plot_directive`¶

在Sphinx文档中包含Matplotlib绘图的指令¶

默认情况下，在HTML输出中， plot 将包含一个.png文件，其中包含指向高分辨率.png和.pdf的链接。在 Latex 输出中，它将包含.pdf。

绘图的源代码可以包括以下三种方式之一：

源文件的路径 作为指令的参数：
```
.. plot:: path/to/plot.py
```
当给定源文件的路径时，指令的内容可以选择包含绘图的标题：：
```
.. plot:: path/to/plot.py

   The plot's caption.
```
此外，可以在导入模块后立即指定要调用的函数的名称（不带参数）：：
```
.. plot:: path/to/plot.py plot_function1
```

包括作为 展示内嵌内容 指令：

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

使用 doctest 语法：

.. plot::

   A plotting example:
   >>> import matplotlib.pyplot as plt
   >>> plt.plot([1, 2, 3], [4, 5, 6])

选项¶

这个 plot 指令支持以下选项：

格式'python'、'doctest'
输入的格式。

包括来源布尔
是否显示源代码。可以使用 plot_include_source 变量在 conf.py .

编码STR
如果此源文件采用非UTF8或非ASCII编码，则必须使用 :encoding: 选项。不会使用 -*- coding -*- 元计算。

语境布尔或STR
如果提供，代码将在所有以前的plot指令的上下文中运行，其中 :context: 已指定选项。这只适用于内联代码绘图指令，而不是那些从文件运行的指令。如果 :context: reset 选项已指定，将重置此绘图和未来绘图的上下文，并在运行代码之前关闭以前的图形。 :context: close-figs 保留上下文，但在运行代码前关闭前面的数字。

NFIGIs布尔
如果指定，将运行代码块，但不会插入数字。这通常对 :context: 选择权。

此外，此指令支持 image 指令，除了目标（因为绘图将添加自己的目标）。这些包括 alt ，高度，宽度，规模，排列和类 .

配置选项¶

plot指令具有以下配置选项：

plot_include_source
包含源选项的默认值

plot_html_show_source_link
是否以HTML格式显示指向源的链接。

plot_pre_code
应在每个绘图之前执行的代码。如果未指定或未指定，则默认为包含以下内容的字符串：
import numpy as np
from matplotlib import pyplot as plt
plot_basedir
基本目录，其中 plot:: 文件名是相对于的。（如果没有或为空，则文件名相对于包含该指令的文件所在的目录。）

plot_formats
要生成的文件格式。元组或字符串列表：
[(suffix, dpi), suffix, ...]
它决定了文件格式和DPI。对于DPI被省略的条目，将选择合理的默认值。当通过sphinx_build从命令行传递时，列表应作为后缀：dpi,后缀：dpi, ...
plot_html_show_formats
是否以HTML格式显示指向文件的链接。

plot_rcparams
一种字典，其中包含应在每个绘图之前应用的任何非标准RCPARAM。

plot_apply_rcparams
默认情况下，当 :context: 在plot指令中未使用选项。此配置选项覆盖此行为，并在每个绘图之前应用RCPARAM。

plot_working_directory
默认情况下，工作目录将更改为示例的目录，因此代码可以获取其数据文件（如果有）。它的路径也将添加到 sys.path 所以它可以导入它旁边的任何助手模块。此配置选项可用于指定中心目录（也可添加到 sys.path ）所有代码的数据文件和助手模块的位置。

plot_template
提供用于准备重新构造的文本的自定义模板。

class matplotlib.sphinxext.plot_directive.PlotDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[源代码]¶

这个 .. plot:: 指令，如模块的docstring中所述。

run()[源代码]¶: 运行plot指令。

exception matplotlib.sphinxext.plot_directive.PlotError[源代码]¶

matplotlib.sphinxext.plot_directive.mark_plot_labels(app, document)[源代码]¶: 为了使绘图可引用，我们需要将引用从“htmlonly”（或“latexonly”）节点移动到实际图形节点本身。

matplotlib.sphinxext.plot_directive.out_of_date(original, derived)[源代码]¶: 返回是否 衍生的 已过期，相对于 起初的 ，这两个路径都是完整的文件路径。

matplotlib.sphinxext.plot_directive.render_figures(code, code_path, output_dir, output_base, context, function_name, config, context_reset=False, close_figs=False)[源代码]¶

运行pyplot脚本并将图像保存在 output_dir .

将图像保存在 output_dir 文件名来自 output_base

matplotlib.sphinxext.plot_directive.run_code(code, code_path, ns=None, function_name=None)[源代码]¶: 从路径导入一个python模块，并运行由name给出的函数（如果函数名不是none）。

matplotlib.sphinxext.plot_directive.split_code_at_show(text)[源代码]¶: 拆分代码位置表演().

matplotlib.sphinxext.plot_directive.unescape_doctest(text)[源代码]¶: 从包含python代码或doctest的文本中提取代码。

matplotlib.sphinxext.plot_directive¶

在Sphinx文档中包含Matplotlib绘图的指令¶

选项¶

配置选项¶

`matplotlib.sphinxext.plot_directive`¶