matplotlib.sphinxext.plot_directive#
Eine Anweisung zum Einfügen eines Matplotlib-Plots in ein Sphinx-Dokument #
Standardmäßig plotenthält die HTML-Ausgabe eine .png-Datei mit einem Link zu einer hochauflösenden .png- und .pdf-Datei. In der LaTeX-Ausgabe enthält es eine .pdf.
Der Quellcode für die Handlung kann auf drei Arten eingefügt werden:
Ein Pfad zu einer Quelldatei als Argument für die Direktive:
.. plot:: path/to/plot.py
Wenn ein Pfad zu einer Quelldatei angegeben wird, kann der Inhalt der Direktive optional eine Beschriftung für die Handlung enthalten:
.. plot:: path/to/plot.py The plot caption.
Zusätzlich kann man den Namen einer aufzurufenden Funktion (ohne Argumente) unmittelbar nach dem Importieren des Moduls angeben:
.. plot:: path/to/plot.py plot_function1
Als Inline-Inhalt in die Richtlinie aufgenommen:
.. 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)
Verwendung der Doctest- Syntax:
.. plot:: A plotting example: >>> import matplotlib.pyplot as plt >>> plt.plot([1, 2, 3], [4, 5, 6])
Optionen #
Die plotDirektive unterstützt die folgenden Optionen:
- Format {'python', 'doctest'}
Das Format der Eingabe. Wenn nicht gesetzt, wird das Format automatisch erkannt.
- Include-Quelle bool
Ob der Quellcode angezeigt werden soll. Der Standardwert kann mit der
plot_include_sourceVariable in geändert werdenconf.py(die selbst standardmäßig auf False gesetzt ist).- Kodierung str
Wenn diese Quelldatei in einer Nicht-UTF8- oder Nicht-ASCII-Codierung vorliegt, muss die Codierung mit der
:encoding:Option angegeben werden. Die Kodierung wird nicht aus dem Metakommentar abgeleitet.-*- coding -*-- Kontext bool oder str
Falls angegeben, wird der Code im Kontext aller vorherigen Plotdirektiven ausgeführt, für die die
:context:Option angegeben wurde. Dies gilt nur für Inline-Code-Plot-Direktiven, nicht für solche, die von Dateien ausgeführt werden. Wenn die Option angegeben ist, wird der Kontext für diese und zukünftige Diagramme zurückgesetzt und vorherige Abbildungen werden geschlossen, bevor der Code ausgeführt wird. behält den Kontext bei, schließt jedoch vorherige Abbildungen, bevor der Code ausgeführt wird.:context: reset:context: close-figs- nofigs bool
Wenn angegeben, wird der Codeblock ausgeführt, aber es werden keine Zahlen eingefügt. Dies ist normalerweise mit der
:context:Option nützlich.- Bildunterschrift _
Wenn angegeben, wird das Argument der Option als Beschriftung für die Abbildung verwendet. Dadurch wird die im Inhalt angegebene Beschriftung überschrieben, wenn der Plot aus einer Datei generiert wird.
Außerdem unterstützt diese Direktive alle Optionen der image
Direktive, mit Ausnahme von target (da plot sein eigenes Ziel hinzufügt). Dazu gehören Alt , Höhe , Breite , Skalierung , Ausrichtung und Klasse .
Konfigurationsoptionen #
Die Plot-Direktive hat die folgenden Konfigurationsoptionen:
- plot_include_source
Standardwert für die Option include-source (Standard: False).
- plot_html_show_source_link
Ob ein Link zur Quelle in HTML angezeigt werden soll (Standard: True).
- plot_pre_code
Code, der vor jedem Plot ausgeführt werden sollte. Wenn None (Standardeinstellung), wird standardmäßig eine Zeichenfolge verwendet, die Folgendes enthält:
import numpy as np from matplotlib import pyplot as plt- plot_basedir
Basisverzeichnis, zu dem
plot::Dateinamen relativ sind. Wenn None oder leer (Standardeinstellung), sind die Dateinamen relativ zu dem Verzeichnis, in dem sich die Datei mit der Anweisung befindet.- plot_formate
Zu generierende Dateiformate (Standard: ['png', 'hires.png', 'pdf']). Liste von Tupeln oder Strings:
[(suffix, dpi), suffix, ...]die das Dateiformat und die DPI bestimmen. Für Einträge, deren DPI weggelassen wurde, werden sinnvolle Voreinstellungen gewählt. Beim Passieren von der Befehlszeile durch sphinx_build sollte die Liste als Suffix:dpi,Suffix:dpi, ... übergeben werden.
- plot_html_show_formats
Ob Links zu den Dateien in HTML angezeigt werden sollen (Standard: True).
- plot_rcparams
Ein Wörterbuch, das alle nicht standardmäßigen rcParams enthält, die vor jedem Plot angewendet werden sollten (Standard: {}).
- plot_apply_rcparams
Standardmäßig werden rcParams angewendet, wenn
:context:option nicht in einer Plot-Direktive verwendet wird. Wenn gesetzt, setzt diese Konfigurationsoption dieses Verhalten außer Kraft und wendet rcParams vor jedem Plot an.- plot_working_directory
Standardmäßig wird das Arbeitsverzeichnis in das Verzeichnis des Beispiels geändert, sodass der Code gegebenenfalls auf seine Datendateien zugreifen kann. Außerdem wird sein Pfad hinzugefügt,
sys.pathdamit es alle Hilfsmodule importieren kann, die daneben sitzen. Diese Konfigurationsoption kann verwendet werden, um ein zentrales Verzeichnis anzugeben (das auch zu hinzugefügt wurdesys.path), in dem sich Datendateien und Hilfsmodule für den gesamten Code befinden.- plot_template
Stellen Sie eine benutzerdefinierte Vorlage zum Vorbereiten von umstrukturiertem Text bereit.
- Klasse matplotlib.sphinxext.plot_directive. PlotDirective ( name , arguments , options , content , lineno , content_offset , block_text , state , state_machine ) [Quelle] #
Die Direktive, wie im Docstring des Moduls dokumentiert.
.. plot::- final_argument_whitespace = Falsch #
Darf das letzte Argument Leerzeichen enthalten?
- has_content = True #
Darf die Richtlinie Inhalt haben?
- option_spec = {'align': <Funktion Image.align>, 'alt': <Funktion unverändert>, 'caption': <Funktion unverändert>, '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': <Funktionsflag >, 'scale': <function nonnegative_int>, 'Breite': <Funktionslänge_oder_prozentsatz_oder_einheitlos >} #
Zuordnung von Optionsnamen zu Prüffunktionen.
- optionale_argumente = 2 #
Anzahl der optionalen Argumente nach den erforderlichen Argumenten.
- erforderliche_argumente = 0 #
Anzahl der erforderlichen Direktivenargumente.
- matplotlib.sphinxext.plot_directive. mark_plot_labels ( App , Dokument ) [Quelle] #
Um Diagramme referenzierbar zu machen, müssen wir die Referenz vom "htmlonly"- (oder "latexonly")-Knoten zum eigentlichen figure-Knoten selbst verschieben.
- matplotlib.sphinxext.plot_directive. out_of_date ( original , abgeleitet , enthält = None ) [Quelle] #
Geben Sie zurück, ob die abgeleitete Datei relativ zum Original oder zu einer der darin enthaltenen RST -Dateien veraltet ist, indem Sie die RST-Anweisung include ( include ) verwenden. abgeleitet und original sind vollständige Pfade, und Includes ist optional eine Liste vollständiger Pfade, die möglicherweise in der ursprünglichen enthalten waren .
- 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 ) [Quelle] #
Führen Sie ein Pyplot-Skript aus und speichern Sie die Bilder in output_dir .
Speichern Sie die Bilder unter output_dir mit Dateinamen, die von output_base abgeleitet sind
- matplotlib.sphinxext.plot_directive. run_code ( code , code_path , ns = None , function_name = None ) [Quelle] #
[ Veraltet ] Importieren Sie ein Python-Modul aus einem Pfad und führen Sie die durch den Namen angegebene Funktion aus, wenn Funktionsname nicht None ist.
Anmerkungen
Veraltet seit Version 3.5.