matplotlib.sphinxext.plot_directive#

Una direttiva per includere un grafico Matplotlib in un documento Sphinx #

Per impostazione predefinita, nell'output HTML, plotincluderà un file .png con un collegamento a un file .png e .pdf ad alta risoluzione. Nell'output LaTeX, includerà un .pdf.

Il codice sorgente per la trama può essere incluso in uno dei tre modi seguenti:

  1. Un percorso a un file di origine come argomento della direttiva:

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

    Quando viene fornito un percorso a un file sorgente, il contenuto della direttiva può facoltativamente contenere una didascalia per la trama:

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

   The plot caption.

    Inoltre, si può specificare il nome di una funzione da chiamare (senza argomenti) subito dopo aver importato il modulo:

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

  2. Incluso come contenuto in linea della direttiva:

    .. 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 sintassi doctest :

    .. plot::

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

Opzioni #

La plotdirettiva supporta le seguenti opzioni:

formato {'python', 'doctest'}

Il formato dell'input. Se non impostato, il formato viene rilevato automaticamente.

include-source bool

Indica se visualizzare il codice sorgente. L'impostazione predefinita può essere modificata utilizzando la plot_include_sourcevariabile in conf.py(che a sua volta è impostata su False).

codifica str

Se questo file di origine è in una codifica non UTF8 o non ASCII, la codifica deve essere specificata utilizzando l' :encoding:opzione. La codifica non verrà dedotta utilizzando il metacommento.-*- coding -*-

contesto bool o str

Se fornito, il codice verrà eseguito nel contesto di tutte le direttive plot precedenti per le quali :context:è stata specificata l'opzione. Questo si applica solo alle direttive di tracciamento del codice in linea, non a quelle eseguite dai file. Se l' opzione è specificata, il contesto viene reimpostato per questo e per i grafici futuri e le cifre precedenti vengono chiuse prima dell'esecuzione del codice. mantiene il contesto ma chiude le figure precedenti prima di eseguire il codice.:context: reset:context: close-figs

nofig bool

Se specificato, verrà eseguito il blocco di codice, ma non verranno inserite cifre. Di solito è utile con l' :context:opzione.

didascalia str

Se specificato, l'argomento dell'opzione verrà utilizzato come didascalia per la figura. Questo sovrascrive la didascalia data nel contenuto, quando la trama è generata da un file.

Inoltre, questa direttiva supporta tutte le opzioni della image direttiva, ad eccezione di target (poiché plot aggiungerà il proprio target). Questi includono alt , height , width , scale , align e class .

Opzioni di configurazione #

La direttiva plot ha le seguenti opzioni di configurazione:

plot_include_source

Valore predefinito per l'opzione include-source (predefinito: False).

plot_html_show_source_link

Se mostrare un collegamento alla fonte in HTML (predefinito: True).

plot_pre_code

Codice che deve essere eseguito prima di ogni trama. Se None (impostazione predefinita), per impostazione predefinita verrà impostata una stringa contenente:

import numpy as np
from matplotlib import pyplot as plt
plot_basedir

Directory di base, a cui plot::sono relativi i nomi dei file. Se None o vuoto (impostazione predefinita), i nomi dei file sono relativi alla directory in cui si trova il file contenente la direttiva.

plot_formats

Formati file da generare (predefinito: ['png', 'hires.png', 'pdf']). Elenco di tuple o stringhe:

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

che determinano il formato del file e il DPI. Per le voci il cui DPI è stato omesso, vengono scelti valori predefiniti ragionevoli. Quando si passa dalla riga di comando a sphinx_build, l'elenco deve essere passato come suffisso:dpi,suffisso:dpi, ...

plot_html_show_formats

Se mostrare i collegamenti ai file in HTML (predefinito: True).

plot_rcparams

Un dizionario contenente qualsiasi rcParams non standard che dovrebbe essere applicato prima di ogni grafico (predefinito: {}).

plot_apply_rcparams

Per impostazione predefinita, rcParams viene applicato quando l' :context:opzione non viene utilizzata in una direttiva plot. Se impostata, questa opzione di configurazione ignora questo comportamento e applica rcParams prima di ogni grafico.

plot_directory_di_lavoro

Per impostazione predefinita, la directory di lavoro verrà modificata nella directory dell'esempio, in modo che il codice possa accedere ai suoi file di dati, se presenti. Anche il suo percorso verrà aggiunto in sys.pathmodo che possa importare qualsiasi modulo di supporto che si trova accanto ad esso. Questa opzione di configurazione può essere utilizzata per specificare una directory centrale (anch'essa aggiunta a sys.path) in cui si trovano i file di dati e i moduli helper per tutto il codice.

plot_template

Fornire un modello personalizzato per la preparazione del testo ristrutturato.

classe matplotlib.sphinxext.plot_directive. PlotDirective ( name , arguments , options , content , lineno , content_offset , block_text , state , state_machine ) [fonte] #

La direttiva, come documentato nella docstring del modulo... plot::

final_argument_whitespace = Falso #

L'argomento finale può contenere spazi bianchi?

has_content = Vero #

La direttiva può avere un contenuto?

option_spec = {'align': <funzione Image.align>, 'alt': <funzione invariata>, 'caption': <funzione invariata>, 'class': <funzione 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': <flag di funzione>, 'scale': <function nonnegative_int>, 'larghezza': <funzione lunghezza_o_percentuale_o_senza_unità>} #

Mappatura dei nomi delle opzioni alle funzioni del validatore.

argomenti_facoltativi = 2 #

Numero di argomenti facoltativi dopo gli argomenti obbligatori.

argomenti_richiesti = 0 #

Numero di argomenti di direttiva richiesti.

esegui ( ) [fonte] #

Eseguire la direttiva plot.

eccezione matplotlib.sphinxext.plot_directive. PlotError [fonte] #
matplotlib.sphinxext.plot_directive. mark_plot_labels ( app , documento ) [fonte] #

Per rendere i grafici referenziabili, dobbiamo spostare il riferimento dal nodo "htmlonly" (o "latexonly") al nodo figure effettivo stesso.

matplotlib.sphinxext.plot_directive. out_of_date ( originale , derivato , include = Nessuno ) [fonte] #

Restituisce se derivato non è aggiornato rispetto all'originale oa uno qualsiasi dei file RST inclusi in esso utilizzando la direttiva RST include ( include ). derivato e originale sono percorsi completi e include è facoltativamente un elenco di percorsi completi che potrebbero essere stati inclusi nel file 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 ) [fonte] #

Esegui uno script pyplot e salva le immagini in output_dir .

Salva le immagini in output_dir con nomi di file derivati ​​da output_base

matplotlib.sphinxext.plot_directive. codice_esecuzione ( codice , percorso_codice , ns = Nessuno , nome_funzione = Nessuno ) [fonte] #

[ Deprecato ] Importa un modulo Python da un percorso ed esegui la funzione data da nome, se nome_funzione non è None.

Appunti

Deprecato dalla versione 3.5.

matplotlib.sphinxext.plot_directive. split_code_at_show ( testo ) [fonte] #

[ Deprecato ] Suddividi il codice in plt.show().

Appunti

Deprecato dalla versione 3.5.

matplotlib.sphinxext.plot_directive. unescape_doctest ( testo ) [fonte] #

[ Deprecato ] Estrai il codice da una parte di testo, che contiene codice Python o doctest.

Appunti

Deprecato dalla versione 3.5: usa invece doctest.script_from_examples.