Spec-Zone.ru › Matplotlib 3.6

matplotlib.sphinxext.mathmpl

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

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

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

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

  1. В строке, используя роль:

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

    что даёт:

    Этот текст использует встроенную математику: .

  2. Самостоятельно, используя директиву:

    Here is some standalone math:
    
    .. mathmpl::
    
        \alpha > \beta
    

    что даёт:

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

Параметры

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

fontsetstr, по умолчанию: 'cm'

Набор шрифтов для отображения математики. См. rcParams["mathtext.fontset"] (по умолчанию: 'dejavusans').

fontsizefloat

Размер шрифта в пунктах. По умолчанию соответствует значению из параметра конфигурации расширения, определённого ниже.

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

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

mathmpl_fontsizefloat, по умолчанию: 10.0

Размер шрифта по умолчанию в пунктах.

mathmpl_srcsetсписок str, по умолчанию: []

Дополнительные размеры изображений для генерации при встраивании в 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

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

© 2012–2023 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.6.0/api/sphinxext_mathmpl_api.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API