matplotlib.sphinxext.plot_directive

Директива для включения графика Matplotlib в документ Sphinx

По умолчанию, в 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 поддерживает следующие параметры:

format{'python', 'doctest'}: Формат входных данных.
include-sourcebool: Отображать ли исходный код. Значение по умолчанию можно изменить, используя переменную plot_include_source в conf.py.
encodingstr: Если этот исходный файл имеет кодировку, отличную от UTF-8 или ASCII, кодировку необходимо указать с помощью параметра :encoding:. Кодировка не будет определена с помощью метакомментария -*- coding -*-.
contextbool or str: Если указано, код будет выполнен в контексте всех предыдущих директив графика, для которых был указан параметр :context:. Это относится только к встроенным директивам графика, а не к тем, которые запускаются из файлов. Если указан параметр :context: reset , контекст сброшен для этого и последующих графиков, и предыдущие фигуры закрыты перед выполнением кода. :context: close-figs сохраняет контекст, но закрывает предыдущие фигуры перед выполнением кода.
nofigsbool: Если указано, блок кода будет выполнен, но фигуры не будут вставлены. Это обычно полезно с параметром :context:.

Кроме того, эта директива поддерживает все параметры директивы image , за исключением параметра target (поскольку график добавит свой собственный параметр). Это включает в себя alt, height, width, scale, align и class.

Параметры конфигурации

Директива графика имеет следующие параметры конфигурации:

plot_include_source

Значение по умолчанию для параметра include-source

plot_html_show_source_link

Отображать ли ссылку на исходный код в HTML.

plot_pre_code

Код, который должен быть выполнен перед каждым графиком. Если не указано или равно None, он будет по умолчанию содержать строку:

import numpy as np
from matplotlib import pyplot as plt

plot_basedir

Базовая директория, к которой plot:: имена файлов относительны. (Если None или пустая строка, имена файлов относительны к директории, содержащей файл с директивой.)

plot_formats

Форматы файлов для генерации. Список кортежей или строк:

[(suffix, dpi), suffix, ...]

определяющие формат файла и DPI. Для записей, DPI которых не указано, выбираются разумные значения по умолчанию. При передаче со стороны командной строки через sphinx_build список должен быть передан как suffix:dpi,suffix:dpi, ...

plot_html_show_formats

Отображать ли ссылки на файлы в HTML.

plot_rcparams

Словарь, содержащий все нестандартные rcParams, которые должны быть применены перед каждым графиком.

plot_apply_rcparams

По умолчанию, rcParams применяются, когда параметр :context: не используется в директиве графика. Этот параметр конфигурации переопределяет это поведение и применяет rcParams перед каждым графиком.

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) [source]

Директива .. plot::, как описано в строке документации модуля.

run(self) [source]: Выполнить директиву графика.

exception matplotlib.sphinxext.plot_directive.PlotError [source]

matplotlib.sphinxext.plot_directive.mark_plot_labels(app, document) [source]: Для возможности ссылки на графики, нам необходимо перенести ссылку из узла "htmlonly" (или "latexonly") в сам узел фигуры.

matplotlib.sphinxext.plot_directive.out_of_date(original, derived) [source]: Возвращает, устарел ли derived относительно original, оба из которых являются полными путями к файлам.

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

Запустить скрипт pyplot и сохранить изображения в output_dir.

Сохранить изображения в output_dir с именами файлов, полученными из output_base

matplotlib.sphinxext.plot_directive.run_code(code, code_path, ns=None, function_name=None) [source]: Импортировать Python-модуль из пути и запустить функцию, заданную именем, если function_name не равно None.

matplotlib.sphinxext.plot_directive.split_code_at_show(text) [source]: Разделить код по plt.show().

matplotlib.sphinxext.plot_directive.unescape_doctest(text) [source]: Извлечь код из фрагмента текста, который содержит либо Python-код, либо doctest.