如何定义在 RST 标记中的文本和公式中使用的数学符号?

问题描述 投票:0回答:1

这个问题与使用 RST 标记编写在 readthedocs.io 上发布的技术文档有关。我需要为数学符号定义“快捷方式”符号,这些符号可以在文本中重复使用,也可以在数学块中编写公式。我们的想法是仅定义符号一次,以便它们可以在所有文档中一致使用。

这是一个不起作用的 RST 示例来说明我需要什么:

define x1 = \x_1
define x2 = \x_2

The ratio of the two variables |x1| and |x2| is given by the following formula:
.. math::
        r = \frac{|x1|}{|x2|}

显然,此示例中的 RST 命令和语法不太正确。我怎样才能做到这一点?

math python-sphinx symbols restructuredtext
1个回答
0
投票

您发现了 rST 格式的一般限制:替换可能包含内联标记(包括“数学”角色),但在“数学”指令中不起作用。

在“数学”指令和角色中,您必须使用基于 LaTeX 数学语法的语法,请参阅LaTeX 数学语法

您可能仍然想在文本中定义和使用快捷方式以及在公式中扩展代码:

.. |x1| replace:: :math:`x_1`
.. |x2| replace:: :math:`x_2`

The ratio of the two variables |x1| and |xi| is given by 

.. math:: r = \frac{x_1}{x_2}
© www.soinside.com 2019 - 2024. All rights reserved.