matplotlib.sphinxext.plot_directive

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

По умолчанию, в HTML-выводе plot будет включаться файл .png с ссылкой на высококачественный .png и .pdf. В LaTeX-выводе будет включаться .pdf.

Исходный код графика может быть включен тремя способами:

1. Путь к исходному файлу в качестве аргумента директивы:

   .. plot:: path/to/plot.py
   

   Когда задан путь к исходному файлу, содержимое директивы может необязательно содержать подпись для графика:

   .. plot:: path/to/plot.py
   
      The plot's caption.
   

   Кроме того, можно указать имя функции для вызова (без аргументов) сразу после импорта модуля:

   .. plot:: path/to/plot.py plot_function1
   

2. Включён как встраиваемое содержимое в директиву:

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

3. Используя синтаксис 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 или str

Если указано, код будет выполняться в контексте всех предыдущих директив plot, для которых был задан параметр :context:. Это относится только к встраиваемым директивам plot, а не к директивам, выполняемым из файлов. Если параметр :context: reset указан, контекст сбрасывается для текущего и последующих графиков, а предыдущие фигуры закрываются перед запуском кода. :context: close-figs сохраняет контекст, но закрывает предыдущие фигуры перед запуском кода.

nofigsbool

Если указано, блок кода будет выполнен, но фигуры не будут вставлены. Это обычно полезно с параметром :context:.

captionstr

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

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

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

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

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: не используется в директиве plot. Этот параметр конфигурации переопределяет это поведение и применяет 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()[source]

Выполнить директиву plot.

исключение 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.