matplotlib.sphinxext.mathmpl

Роль и директива для отображения mathtext в Sphinx

Расширение mathmpl Sphinx создаёт изображение mathtext в Matplotlib и отображает его в html-выводе. Таким образом, это точное и верное представление того, что вы увидите, если передадите строку LaTeX в Matplotlib (см. Написание математических выражений).

Предупреждение

В большинстве случаев вам, вероятно, следует использовать одно из встроенных расширений математики Sphinx вместо этого. Встроенная директива Sphinx для математики использует MathJax для рендеринга математических выражений и решает проблемы доступности, которые mathmpl не решает.

Mathtext можно включить двумя способами:

Встроенный, используя роль:
```
This text uses inline math: :mathmpl:`\alpha > \beta`.
```
что даёт:

Этот текст использует встроенную математику: .
Самостоятельный, используя директиву:
```
Here is some standalone math:

.. mathmpl::

    \alpha > \beta
```
что даёт:

Вот немного самостоятельной математики:

Параметры

Роль и директива mathmpl поддерживают следующие параметры:

fontsetstr, по умолчанию: 'cm': Набор шрифтов для отображения математики. См. rcParams["mathtext.fontset"] (по умолчанию: 'dejavusans').
fontsizefloat: Размер шрифта в пунктах. По умолчанию используется значение из параметра конфигурации расширения, определённого ниже.

Параметры конфигурации

Расширение mathtext имеет следующие параметры конфигурации:

mathmpl_fontsizefloat, по умолчанию: 10.0: Размер шрифта по умолчанию в пунктах.
mathmpl_srcsetсписок строк, по умолчанию: []: Дополнительные размеры изображений для генерации при встраивании в HTML для поддержки изображений с отзывчивыми разрешениями. Список должен содержать дополнительные x-описания ('1.5x', '2x', и т. д.) для генерации (1x - по умолчанию и всегда включается).

classmatplotlib.sphinxext.mathmpl.MathDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]

Директива .. mathmpl::, как описано в строке документации модуля.

final_argument_whitespace=False: Может ли последний аргумент содержать пробелы?

has_content=True: Может ли директива содержать контент?

option_spec={'fontset': <function fontset_choice>, 'fontsize': <function _make_type_validator.<locals>.validate_float_or_None>}: Сопоставление имён параметров с функциями-валидаторами.

optional_arguments=0: Количество необязательных аргументов после обязательных аргументов.

required_arguments=0: Количество обязательных аргументов директивы.