matplotlib.sphinxext.plot_directive

Une directive pour inclure un tracé Matplotlib dans un document Sphinx

Par défaut, dans la sortie HTML, plotinclura un fichier .png avec un lien vers un fichier .png et .pdf haute résolution. Dans la sortie LaTeX, il inclura un fichier .pdf.

Le code source du tracé peut être inclus de l'une des trois manières suivantes :

1. Un chemin vers un fichier source comme argument de la directive :

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

   Lorsqu'un chemin vers un fichier source est donné, le contenu de la directive peut éventuellement contenir une légende pour le tracé :

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

   De plus, on peut spécifier le nom d'une fonction à appeler (sans arguments) immédiatement après l'importation du module :

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

2. Inclus en tant que contenu intégré à la directive :

   .. 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. Utilisation de la syntaxe doctest :

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

Option

La plotdirective prend en charge les options suivantes :

formater {'python', 'doctest'}

Le format de l'entrée. S'il n'est pas défini, le format est automatiquement détecté.

inclure-source booléen

Indique s'il faut afficher le code source. La valeur par défaut peut être modifiée à l'aide de la plot_include_sourcevariable in conf.py(qui est elle-même définie par défaut sur False).

chaîne d' encodage

Si ce fichier source est dans un codage non-UTF8 ou non-ASCII, le codage doit être spécifié à l'aide de l' :encoding:option. L'encodage ne sera pas déduit à l'aide du métacommentaire.-*- coding -*-

contexte booléen ou str

S'il est fourni, le code sera exécuté dans le contexte de toutes les directives de tracé précédentes pour lesquelles l' :context:option a été spécifiée. Cela ne s'applique qu'aux directives de tracé de code en ligne, pas à celles exécutées à partir de fichiers. Si l' option est spécifiée, le contexte est réinitialisé pour ce tracé et les futurs, et les figures précédentes sont fermées avant l'exécution du code. conserve le contexte mais ferme les figures précédentes avant d'exécuter le code.:context: reset:context: close-figs

pas de figues bool

Si spécifié, le bloc de code sera exécuté, mais aucun chiffre ne sera inséré. Ceci est généralement utile avec l' :context:option.

chaîne de légende

S'il est spécifié, l'argument de l'option sera utilisé comme légende pour la figure. Cela écrase la légende donnée dans le contenu, lorsque le tracé est généré à partir d'un fichier.

De plus, cette directive prend en charge toutes les options de la image directive, à l'exception de la cible (puisque plot ajoutera sa propre cible). Ceux-ci incluent alt , height , width , scale , align et class .

Options de configuration

La directive plot a les options de configuration suivantes :

plot_include_source

Valeur par défaut de l'option include-source (par défaut : False).

plot_html_show_source_link

Indique s'il faut afficher un lien vers la source en HTML (par défaut : True).

plot_pre_code

Code qui doit être exécuté avant chaque tracé. Si aucun (valeur par défaut), il s'agira par défaut d'une chaîne contenant :

import numpy as np
from matplotlib import pyplot as plt

plot_basedir

Répertoire de base, auquel plot::les noms de fichiers sont relatifs. Si aucun ou vide (valeur par défaut), les noms de fichiers sont relatifs au répertoire où se trouve le fichier contenant la directive.

plot_formats

Formats de fichiers à générer (par défaut : ['png', 'hires.png', 'pdf']). Liste des tuples ou des chaînes :

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

qui déterminent le format de fichier et le DPI. Pour les entrées dont le DPI a été omis, des valeurs par défaut sensibles sont choisies. Lors du passage de la ligne de commande à sphinx_build, la liste doit être passée sous la forme suffixe : dpi, suffixe : dpi, ...

plot_html_show_formats

Indique s'il faut afficher les liens vers les fichiers au format HTML (par défaut : True).

plot_rcparams

Un dictionnaire contenant tous les rcParams non standard qui doivent être appliqués avant chaque tracé (par défaut : {}).

plot_apply_rcparams

Par défaut, rcParams est appliqué lorsque l' :context:option n'est pas utilisée dans une directive plot. Si elle est définie, cette option de configuration remplace ce comportement et applique rcParams avant chaque tracé.

plot_working_directory

Par défaut, le répertoire de travail sera remplacé par le répertoire de l'exemple, afin que le code puisse accéder à ses fichiers de données, le cas échéant. De plus, son chemin sera ajouté sys.pathafin qu'il puisse importer tous les modules d'assistance qui se trouvent à côté de lui. Cette option de configuration peut être utilisée pour spécifier un répertoire central (également ajouté à sys.path) où se trouvent les fichiers de données et les modules d'assistance pour tout le code.

plot_template

Fournir un modèle personnalisé pour la préparation du texte restructuré.

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

La directive, telle que documentée dans la docstring du module... plot::

argument_final_espaceblanc = Faux

L'argument final peut-il contenir des espaces ?

a_content = Vrai

La directive peut-elle avoir un contenu ?

option_spec = {'align' : <fonction Image.align>, 'alt' : <fonction inchangée>, 'caption' : <fonction inchangée>, 'class' : <fonction class_option>, 'context' : <fonction _option_context>, 'encoding' : <function _deprecated_option_encoding>, 'format' : <function _option_format>, 'height' : <function length_or_unitless>, 'include-source' : <function _option_boolean>, 'nofigs' : <indicateur de fonction>, 'échelle' : <function nonnegative_int>, 'largeur' : <function length_or_percentage_or_unitless>}

Mappage des noms d'options aux fonctions de validation.

arguments_facultatifs = 2

Nombre d'arguments facultatifs après les arguments requis.

arguments_requis = 0

Nombre d'arguments de directive requis.

exécuter ( )

Exécutez la directive plot.

exception matplotlib.sphinxext.plot_directive. Erreur de tracé

matplotlib.sphinxext.plot_directive. mark_plot_labels ( application , document )

Pour rendre les tracés référençables, nous devons déplacer la référence du nœud "htmlonly" (ou "latexonly") vers le nœud figure lui-même.

matplotlib.sphinxext.plot_directive. out_of_date ( original , dérivé , inclut = Aucun )

Indique si le dérivé est obsolète par rapport à l'original ou à l'un des fichiers RST qu'il contient à l'aide de la directive RST include (include ) . derive et original sont des chemins d'accès complets, et includes est éventuellement une liste de chemins d'accès complets qui peuvent avoir été inclus dans l' 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 )

Exécutez un script pyplot et enregistrez les images dans output_dir .

Enregistrez les images sous output_dir avec des noms de fichiers dérivés de output_base

matplotlib.sphinxext.plot_directive. run_code ( code , code_path , ns = None , function_name = None )

[ Obsolète ] Importez un module Python à partir d'un chemin et exécutez la fonction indiquée par name, si function_name n'est pas None.

Remarques

Obsolète depuis la version 3.5.

matplotlib.sphinxext.plot_directive. split_code_at_show ( texte )

[ Obsolète ] Code fractionné à plt.show().

Remarques

Obsolète depuis la version 3.5.

matplotlib.sphinxext.plot_directive. unescape_doctest ( texte )

[ Obsolète ] Extraire le code d'un morceau de texte, qui contient soit du code Python, soit des doctests.

Remarques

Obsolète depuis la version 3.5 : utilisez plutôt doctest.script_from_examples.