在docstrings公式中使用“\displaymath”指令

2024-05-23 15:49:03 发布

您现在位置:Python中文网/ 问答频道 /正文

我使用Sphinx文档包来记录我正在开发的一个小Python工具包,我想通过在Python docstrings中以乳胶格式列出各个模块实现的数学公式来描述它们。

对于structuredtext,使用:math:.. math::指令很容易实现这一点,例如:

.. math::
   \\displaymath \\sum_{i=1}^{\\infty} x_{i}

但是在Python docstring中,\\displaymath指令只是以红色文本突出显示。当在.rst文件(例如index.rst)中使用时,它按预期工作,求和的子脚本和超级脚本直接位于求和符号的下面和上面。

这是docstrings不支持的,还是我做错了什么,或者没有做我需要做的事情?


Tags: 模块文档脚本工具包格式sphinx记录指令