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 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 (которая по умолчанию равна False).
encodingstr: Если исходный файл использует кодировку отличную от UTF-8 или ASCII, кодировка должна быть указана с помощью параметра :encoding:. Кодировка не будет определена с помощью -*- coding -*- метакомментария.
contextbool or 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 (значение по умолчанию: False).

plot_html_show_source_link

Показывать ли ссылку на исходный код в HTML (значение по умолчанию: True).

plot_pre_code

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

import numpy as np
from matplotlib import pyplot as plt

plot_basedir

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

plot_formats

Форматы файлов для генерации (значение по умолчанию: ['png', 'hires.png', 'pdf']). Список кортежей или строк:

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

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

plot_html_show_formats

Показывать ли ссылки на файлы в HTML (значение по умолчанию: True).

plot_rcparams

Словарь, содержащий любые нестандартные rcParams, которые должны быть применены перед каждым графиком (значение по умолчанию: {}).

plot_apply_rcparams

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

plot_working_directory

По умолчанию рабочая директория будет изменена на директорию примера, чтобы код мог получить доступ к его файлам данных, если таковые имеются. Также его путь будет добавлен в sys.path, чтобы он мог импортировать любые вспомогательные модули, расположенные рядом с ним. Этот параметр конфигурации можно использовать для указания центральной директории (также добавленной в sys.path), где хранятся файлы данных и вспомогательные модули для всего кода.

plot_template

Предоставьте настроенный шаблон для подготовки реструктурированного текста.

класс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, includes=None)[source]: Возвращает, является ли derived устаревшим по отношению к original или к любому из RST файлов, включенных в него с помощью директивы RST include (includes). derived и original — полные пути, а includes — необязательный список полных путей, которые могли быть включены в original.

matplotlib.sphinxext.plot_directive.render_figures(code, code_path, output_dir, output_base, context, function_name, config, context_reset=False, close_figs=False, code_includes=None)[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.

Примечания

Устарело начиная с версии 3.5.

matplotlib.sphinxext.plot_directive.split_code_at_show(text)[source]: [Устарело] Разделяет код на plt.show().

Примечания

Устарело начиная с версии 3.5.

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

Примечания

Устарело начиная с версии 3.5.

matplotlib.sphinxext.plot_directive

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

Параметры

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

Примечания

Примечания

Примечания