matplotlib.sphinxext.mathmpl
#
在Sphinx 中显示数学文本的角色和指令
警告
在大多数情况下,您可能希望使用Sphinx 的内置数学扩展 之一而不是这个。
Mathtext 可以通过两种方式包含:
内联,使用角色:
This text uses inline math: :mathmpl:`\alpha > \beta`.
产生:
本文使用内联数学: .
独立,使用指令:
Here is some standalone math: .. mathmpl:: \alpha > \beta
产生:
这是一些独立的数学:
选项#
mathmpl
角色和指令都支持以下选项:
- fontset str,默认值:'cm'
显示数学时使用的字体集。请参阅
rcParams["mathtext.fontset"]
(默认值:'dejavusans'
)。- 字体大小浮动
字体大小,以磅为单位。默认为下面定义的扩展配置选项的值。
配置选项#
mathtext 扩展具有以下配置选项:
- mathmpl_fontsize浮点数,默认值:10.0
默认字体大小,以磅为单位。
- mathmpl_srcset str 列表,默认值:[]
嵌入 HTML 时生成的其他图像大小,以支持 响应式分辨率图像。该列表应包含要生成的附加 x 描述符(
'1.5x'
、'2x'
等)(1x 是默认值,并且始终包括在内。)
- 类 matplotlib.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>} #
将选项名称映射到验证器函数。
- 可选参数= 0 #
必需参数之后的可选参数的数量。
- required_arguments = 0 #
所需指令参数的数量。