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 code, а не к тем, которые выполняются из файлов. Если указан параметр :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 список должен передаваться в формате suffix:dpi,suffix: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::, как описано в строке документации модуля.

final_argument_whitespace=False: Может ли последний аргумент содержать пробелы?

has_content=True: Может ли директива содержать контент?

option_spec={'align': <function Image.align>, 'alt': <function unchanged>, 'caption': <function unchanged>, 'class': <function class_option>, 'context': <function _option_context>, 'encoding': <function _deprecated_option_encoding>, 'format': <function _option_format>, 'height': <function length_or_unitless>, 'include-source': <function _option_boolean>, 'nofigs': <function flag>, 'scale': <function nonnegative_int>, 'width': <function length_or_percentage_or_unitless>}: Сопоставление имен параметров с функциями-валидаторами.

optional_arguments=2: Количество необязательных аргументов после обязательных аргументов.

required_arguments=0: Количество обязательных аргументов директивы.

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: Используйте вместо этого doctest.script_from_examples.

matplotlib.sphinxext.plot_directive

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

Параметры

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

Примечания

Примечания

Примечания