matplotlib.sphinxext.mathmpl#

Eine Rolle und Direktive zur Anzeige von Mathtext in Sphinx#

Die Sphinx-Erweiterung mathmpl erstellt ein Mathtext-Bild in Matplotlib und zeigt es in der HTML-Ausgabe an. Somit ist sie eine echte und getreue Darstellung dessen, was Sie sehen würden, wenn Sie einen gegebenen LaTeX-String an Matplotlib übergeben (siehe Mathematische Ausdrücke schreiben).

Warnung

In den meisten Fällen möchten Sie wahrscheinlich eine der eingebauten Mathe-Erweiterungen von Sphinx anstelle dieser verwenden. Die eingebaute Sphinx-Mathe-Direktive verwendet MathJax zum Rendern mathematischer Ausdrücke und adressiert Barrierefreiheitsbedenken, die mathmpl nicht adressiert.

Mathtext kann auf zwei Arten eingebunden werden

  1. Inline, mit der Rolle

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

    was Folgendes erzeugt

    Dieser Text verwendet Inline-Mathe: .

  2. Eigenständig, mit der Direktive

    Here is some standalone math:

.. mathmpl::

    \alpha > \beta

    was Folgendes erzeugt

    Hier ist etwas eigenständige Mathematik

Optionen#

Die mathmpl-Rolle und -Direktive unterstützen beide die folgenden Optionen

fontsetstr, Standard: 'cm'

Die zu verwendende Schriftart für die Anzeige von Mathe. Siehe rcParams["mathtext.fontset"] (Standard: 'dejavusans').

fontsizefloat

Die Schriftgröße in Punkten. Standardmäßig wird der Wert der unten definierten Konfigurationsoption der Erweiterung verwendet.

Konfigurationsoptionen#

Die Mathtext-Erweiterung verfügt über die folgenden Konfigurationsoptionen

mathmpl_fontsizefloat, Standard: 10.0

Standard-Schriftgröße in Punkten.

mathmpl_srcsetlist of str, Standard: []

Zusätzliche Bildgrößen, die beim Einbetten in HTML generiert werden, um responsive Auflösungsbilder zu unterstützen. Die Liste sollte zusätzliche x-Deskriptoren enthalten ('1.5x', '2x', usw.), die generiert werden sollen (1x ist der Standard und immer enthalten).

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

Die Direktive .. mathmpl::, wie in der Docstring des Moduls dokumentiert.

final_argument_whitespace = False#

Darf das letzte Argument Leerzeichen enthalten?

has_content = True#

Darf die Direktive Inhalt haben?

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

Zuordnung von Optionsnamen zu Validatorfunktionen.

optional_arguments = 0#

Anzahl der optionalen Argumente nach den erforderlichen Argumenten.

required_arguments = 0#

Anzahl der erforderlichen Direktivenargumente.

Auf dieser Seite