matplotlib.sphinxext.mathmpl
Роль и директива для отображения mathtext в Sphinx
Предупреждение
В большинстве случаев вы, вероятно, захотите использовать один из встроенных расширений Math Sphinx вместо этого.
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::, как описано в строке документации модуля.
© 2012–2021 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.5.1/api/sphinxext_mathmpl_api.html
.