matplotlib.sphinxext.plot_directive#
Sphinx ドキュメントに Matplotlib プロットを含めるためのディレクティブ#
デフォルトでは、HTML 出力にplot、高解像度の .png および .pdf へのリンクを含む .png ファイルが含まれます。LaTeX 出力では、.pdf が含まれます。
プロットのソース コードは、次の 3 つの方法のいずれかで含めることができます。
ディレクティブへの引数としてのソース ファイルへのパス:
.. 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'}
入力の形式。設定されていない場合、フォーマットは自動検出されます。
- インクルードソースブール
ソースコードを表示するかどうか。
plot_include_sourceデフォルトは、変数 inを使用して変更できますconf.py(それ自体のデフォルトは False です)。- エンコーディング文字列
このソース ファイルが非 UTF8 または非 ASCII エンコーディングの場合、
:encoding:オプションを使用してエンコーディングを指定する必要があります。エンコーディングは、メタコメントを使用して推測されません。-*- coding -*-- コンテキストbool または str
指定した場合、コードは、
:context:オプションが指定された以前のすべてのプロット ディレクティブのコンテキストで実行されます。これは、ファイルから実行されるものではなく、インライン コード プロット ディレクティブにのみ適用されます。このオプションが指定されている場合、このプロットと将来のプロットのコンテキストがリセットされ、コードを実行する前に前の Figure が閉じられます。コンテキストを保持しますが、コードを実行する前に前の Figure を閉じます。:context: reset:context: close-figs- nofigsブール
指定すると、コード ブロックが実行されますが、図は挿入されません。これは通常、
:context:オプションで役立ちます。- キャプション文字列
指定した場合、オプションの引数は Figure のキャプションとして使用されます。これは、プロットがファイルから生成されるときに、コンテンツで指定されたキャプションを上書きします。
さらに、このディレクティブは、targetimage
を除くディレクティブのすべてのオプションをサポートします(plot は独自のターゲットを追加するため)。これらには、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 または空 (デフォルト) の場合、ファイル名は、ディレクティブを含むファイルが存在するディレクトリに対して相対的になります。- プロットフォーマット
生成するファイル形式 (デフォルト: ['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
:context:オプションが plot ディレクティブで使用されていない場合、デフォルトで rcParams が適用されます。設定されている場合、この構成オプションはこの動作をオーバーライドし、各プロットの前に rcParams を適用します。- plot_working_directory
デフォルトでは、作業ディレクトリは例のディレクトリに変更されるため、コードはデータ ファイルがあればそれを取得できます。また、そのパスが追加される
sys.pathため、その横にあるヘルパー モジュールをインポートできます。sys.pathこの構成オプションを使用して、すべてのコードのデータ ファイルとヘルパー モジュールが配置される中央ディレクトリ ( にも追加される) を指定できます。- プロット テンプレート
再構成されたテキストを準備するためのカスタマイズされたテンプレートを提供します。
- クラス matplotlib.sphinxext.plot_directive. PlotDirective ( name , arguments , options , content , lineno , content_offset , block_text , state , state_machine ) [source] #
モジュールのdocstring に記載されているディレクティブ。
.. plot::- final_argument_whitespace = False #
最後の引数に空白を含めることはできますか?
- has_content = True #
ディレクティブにコンテンツを含めることはできますか?
- option_spec = {'align': <関数のImage.align>, 'alt': <関数の変更なし>, 'caption': <関数の変更なし>, 'class': <関数のクラス_オプション>, 'context': <関数のオプション_コンテキスト>, 'encoding': <function _deprecated_option_encoding>, 'format': <function _option_format>, 'height': <function length_or_unitless>, 'include-source': <function _option_boolean>, 'nofigs': <関数フラグ>, 'スケール': <関数の非負の整数>, 'width': <function length_or_percentage_or_unitless>} #
オプション名のバリデータ関数へのマッピング。
- オプションの引数= 2 #
必須引数の後のオプション引数の数。
- 必須引数= 0 #
必要なディレクティブ引数の数。
- matplotlib.sphinxext.plot_directive. mark_plot_labels ( app , document ) [ソース] #
プロットを参照可能にするには、参照を「htmlonly」(または「latexonly」) ノードから実際の Figure ノード自体に移動する必要があります。
- matplotlib.sphinxext.plot_directive. out_of_date (オリジナル、派生、インクルード=なし) [ソース] #
RST インクルード ディレクティブ ( includes ) を使用して、派生ファイルがオリジナルまたはそれに含まれる RST ファイルのいずれかに対して古くなっているかどうかを返します。 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_baseから派生したファイル名を使用して、 output_dirの下に画像を保存します。
- matplotlib.sphinxext.plot_directive. run_code ( code , code_path , ns = None , function_name = None ) [source] #
[非推奨] パスから Python モジュールをインポートし、関数名が None でない場合、名前で指定された関数を実行します。
ノート
バージョン 3.5 以降は非推奨です。