matplotlib.sphinxext.mathmpl#

Eine Rolle und Anweisung zum Anzeigen von Mathtext in Sphinx #

Warnung

In den meisten Fällen werden Sie wahrscheinlich eine der eingebauten Math-Erweiterungen von Sphinx anstelle dieser verwenden wollen.

Mathtext kann auf zwei Arten eingebunden werden:

  1. Inline mit der Rolle:

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

    was produziert:

    Dieser Text verwendet Inline-Mathematik: .

  2. Eigenständig, mit der Direktive:

    Here is some standalone math:

.. mathmpl::

    \alpha > \beta

    was produziert:

    Hier ist einige eigenständige Mathematik:

Optionen #

Sowohl die mathmplRolle als auch die Direktive unterstützen die folgenden Optionen:

fontset str, Standard: 'cm'

Die Schriftart, die bei der Anzeige von Mathematik verwendet werden soll. Siehe rcParams["mathtext.fontset"](Standard: 'dejavusans').

Schriftgröße Float

Die Schriftgröße in Punkt. Standardmäßig der Wert aus der unten definierten Erweiterungskonfigurationsoption.

Konfigurationsoptionen #

Die mathtext-Erweiterung hat die folgenden Konfigurationsoptionen:

mathmpl_fontsize Float, Standard: 10.0

Standardschriftgröße in Punkt.

mathmpl_srcset Liste von str, Standard: []

Zusätzliche Bildgrößen, die beim Einbetten in HTML generiert werden müssen, um Bilder mit responsiver Auflösung zu unterstützen . Die Liste sollte zusätzliche zu generierende x-Deskriptoren ( '1.5x', '2x', etc.) enthalten (1x ist der Standardwert und immer enthalten.)

Klasse matplotlib.sphinxext.mathmpl. MathDirective ( name , arguments , options , content , lineno , content_offset , block_text , state , state_machine ) [Quelle] #

Die Direktive, wie im Docstring des Moduls dokumentiert... mathmpl::

final_argument_whitespace = Falsch #

Darf das letzte Argument Leerzeichen enthalten?

has_content = True #

Darf die Richtlinie Inhalt haben?

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

Zuordnung von Optionsnamen zu Prüffunktionen.

optionale_argumente = 0 #

Anzahl der optionalen Argumente nach den erforderlichen Argumenten.

erforderliche_argumente = 0 #

Anzahl der erforderlichen Direktivenargumente.