matplotlib.sphinxext.mathmpl#

Sphinx で数学テキストを表示するロールとディレクティブ#

警告

ほとんどの場合、 この拡張機能の代わりに、 Sphinx の組み込みの Math 拡張機能のいずれかを使用することをお勧めします。

Mathtext は、次の 2 つの方法で含めることができます。

  1. ロールを使用したインライン:

    This text uses inline math: :mathmpl:`\alpha > \beta`.

    これは以下を生成します:

    このテキストはインライン数学を使用しています: .

  2. スタンドアロン、ディレクティブを使用:

    Here is some standalone math:

.. mathmpl::

    \alpha > \beta

    これは以下を生成します:

    スタンドアロンの計算は次のとおりです。

オプション#

ロールとディレクティブはmathmplどちらも次のオプションをサポートしています。

フォントセット文字列、デフォルト: 'cm'

数式を表示するときに使用するフォント セット。rcParams["mathtext.fontset"](デフォルト: )を参照してください'dejavusans'。

fontsize float

フォント サイズ (ポイント単位)。デフォルトは、以下で定義されている拡張構成オプションの値です。

設定オプション#

mathtext 拡張機能には、次の構成オプションがあります。

mathmpl_fontsize float、デフォルト: 10.0

デフォルトのフォント サイズ (ポイント単位)。

mathmpl_srcset str のリスト、デフォルト: []

レスポンシブ解像度の画像をサポートするために、HTML に埋め込むときに生成する追加の画像サイズ 。リストには、生成する追加の x 記述子 ( 、 など) が含まれている必要'1.5x'が'2x'あります (1x がデフォルトで、常に含まれています)。

クラス matplotlib.sphinxext.mathmpl. MathDirective ( name , arguments , options , content , lineno , content_offset , block_text , state , state_machine ) [source] #

モジュールのdocstring に記載されているディレクティブ。.. mathmpl::

final_argument_whitespace = False #

最後の引数に空白を含めることはできますか?

has_content = True #

ディレクティブにコンテンツを含めることはできますか?

option_spec = {'fontset': <function fontset_choice>, 'fontsize': <function _make_type_validator.<locals>.validate_float_or_None>} #

オプション名のバリデータ関数へのマッピング。

オプションの引数= 0 #

必須引数の後のオプション引数の数。

必須引数= 0 #

必要なディレクティブ引数の数。