matplotlib.sphinxext.plot_directive

Una directiva para incluir un diagrama de Matplotlib en un documento de Sphinx

De forma predeterminada, en la salida HTML, plotse incluirá un archivo .png con un enlace a un archivo .png y .pdf de alta resolución. En la salida de LaTeX, incluirá un .pdf.

El código fuente de la trama se puede incluir en una de tres formas:

1. Una ruta a un archivo fuente como argumento de la directiva:

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

   Cuando se proporciona una ruta a un archivo fuente, el contenido de la directiva puede contener opcionalmente un título para la trama:

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

   Además, se puede especificar el nombre de una función para llamar (sin argumentos) inmediatamente después de importar el módulo:

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

2. Incluido como contenido en línea de la directiva:

   .. 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. Usando la sintaxis de doctest :

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

Opciones

La plotdirectiva admite las siguientes opciones:

formato {'python', 'doctest'}

El formato de la entrada. Si no está configurado, el formato se detecta automáticamente.

incluir-fuente bool

Ya sea para mostrar el código fuente. El valor predeterminado se puede cambiar usando la plot_include_sourcevariable in conf.py(que a su vez es False).

cadena de codificación

Si este archivo de origen tiene una codificación que no es UTF8 ni ASCII, la codificación debe especificarse mediante la :encoding:opción. La codificación no se inferirá utilizando el metacomentario.-*- coding -*-

contexto bool o str

Si se proporciona, el código se ejecutará en el contexto de todas las directivas de trazado anteriores para las que :context:se especificó la opción. Esto solo se aplica a las directivas de trazado de código en línea, no a las que se ejecutan desde archivos. Si se especifica la opción, el contexto se restablece para este gráfico y los futuros, y las figuras anteriores se cierran antes de ejecutar el código. mantiene el contexto pero cierra las figuras anteriores antes de ejecutar el código.:context: reset:context: close-figs

sin higos bool

Si se especifica, se ejecutará el bloque de código, pero no se insertarán cifras. Esto suele ser útil con la :context:opción.

subtítulo str

Si se especifica, el argumento de la opción se utilizará como título de la figura. Esto sobrescribe el título dado en el contenido, cuando la trama se genera a partir de un archivo.

Además, esta directiva admite todas las opciones de la image directiva, excepto el objetivo (ya que plot agregará su propio objetivo). Estos incluyen alt , alto , ancho , escala , alineación y clase .

Opciones de configuración

La directiva plot tiene las siguientes opciones de configuración:

plot_include_source

Valor predeterminado para la opción incluir origen (predeterminado: Falso).

plot_html_show_source_link

Ya sea para mostrar un enlace a la fuente en HTML (predeterminado: Verdadero).

plot_pre_code

Código que debe ejecutarse antes de cada parcela. Si Ninguno (el valor predeterminado), se establecerá de forma predeterminada en una cadena que contiene:

import numpy as np
from matplotlib import pyplot as plt

plot_basedir

Directorio base, al que plot::se refieren los nombres de los archivos. Si es Ninguno o está vacío (predeterminado), los nombres de los archivos son relativos al directorio donde se encuentra el archivo que contiene la directiva.

formatos_de_trama

Formatos de archivo para generar (predeterminado: ['png', 'hires.png', 'pdf']). Lista de tuplas o cadenas:

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

que determinan el formato de archivo y el DPI. Para las entradas cuyo DPI se omitió, se eligen valores predeterminados sensibles. Al pasar desde la línea de comando a través de sphinx_build, la lista debe pasarse como sufijo: ppp, sufijo: ppp, ...

plot_html_show_formatos

Ya sea para mostrar enlaces a los archivos en HTML (predeterminado: Verdadero).

plot_rcparams

Un diccionario que contiene cualquier rcParams no estándar que se debe aplicar antes de cada gráfico (predeterminado: {}).

plot_apply_rcparams

De forma predeterminada, rcParams se aplica cuando la :context:opción no se usa en una directiva de trazado. Si se establece, esta opción de configuración anula este comportamiento y aplica rcParams antes de cada gráfico.

plot_working_directory

De forma predeterminada, el directorio de trabajo se cambiará al directorio del ejemplo, por lo que el código puede acceder a sus archivos de datos, si los hay. También se agregará su ruta sys.pathpara que pueda importar cualquier módulo auxiliar que se encuentre junto a él. Esta opción de configuración se puede usar para especificar un directorio central (también agregado a sys.path) donde se ubican los archivos de datos y los módulos auxiliares para todo el código.

trama_plantilla

Proporcione una plantilla personalizada para preparar texto reestructurado.

clase matplotlib.sphinxext.plot_directive. PlotDirective ( name , arguments , options , content , lineno , content_offset , block_text , state , state_machine )

La directiva, tal como se documenta en la cadena de documentación del módulo... plot::

final_argument_whitespace = Falso

¿Puede el argumento final contener espacios en blanco?

tiene_contenido = Verdadero

¿Puede la directiva tener contenido?

option_spec = {'align': <función Image.align>, 'alt': <función sin cambios>, 'caption': <función sin cambios>, 'class': <función class_option>, 'context': <función _option_context>, 'codificación': <función _opción_obsoleta_codificación>, 'formato': <función _opción_formato>, 'altura': <función longitud_o_sin_unidades>, 'incluir-fuente': <función _opción_booleana>, 'nofigs': <indicador de función>, 'escala': <función nonnegative_int>, 'ancho': <función longitud_o_porcentaje_o_sin_unidades>}

Asignación de nombres de opciones a funciones de validación.

argumentos_opcionales = 2

Número de argumentos opcionales después de los argumentos obligatorios.

argumentos_requeridos = 0

Número de argumentos de directiva requeridos.

ejecutar ( )

Ejecute la directiva plot.

excepción matplotlib.sphinxext.plot_directive. PlotError

matplotlib.sphinxext.plot_directive. mark_plot_labels ( aplicación , documento )

Para que las gráficas sean referenciables, necesitamos mover la referencia del nodo "htmlonly" (o "latexonly") al nodo de la figura real.

matplotlib.sphinxext.plot_directive. out_of_date ( original , derivado , incluye = Ninguno )

Devuelve si el derivado está desactualizado en relación con el original o cualquiera de los archivos RST incluidos en él utilizando la directiva RST include ( include ) . derivada y original son rutas completas, e include es opcionalmente una lista de rutas completas que pueden haberse incluido en el 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 )

Ejecute un script de pyplot y guarde las imágenes en output_dir .

Guarde las imágenes en output_dir con nombres de archivo derivados de output_base

matplotlib.sphinxext.plot_directive. run_code ( código , code_path , ns = Ninguno , function_name = Ninguno )

[ Obsoleto ] Importe un módulo de Python desde una ruta y ejecute la función proporcionada por nombre, si nombre_función no es Ninguno.

notas

En desuso desde la versión 3.5.

matplotlib.sphinxext.plot_directive. split_code_at_show ( texto )

[ Obsoleto ] Código dividido en plt.show().

notas

En desuso desde la versión 3.5.

matplotlib.sphinxext.plot_directive. unescape_doctest ( texto )

[ Obsoleto ] Extrae el código de un fragmento de texto, que contiene código de Python o doctests.

notas

En desuso desde la versión 3.5: use doctest.script_from_examples en su lugar.