matplotlib.sphinxext.mathmpl

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

Расширение Sphinx mathmpl создаёт изображение 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_srcsetlist of str, по умолчанию: []: Дополнительные размеры изображений для создания при вставке в HTML, чтобы поддерживать адаптивные изображения с различным разрешением. Список должен содержать дополнительные дескрипторы x ('1.5x', '2x' и т. д.) для создания (1x используется по умолчанию и включается всегда).

classmatplotlib.sphinxext.mathmpl.MathDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[исходный код]

Директива .. 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: Количество обязательных аргументов директивы.