python - Sphinx 文档常量替换

Question

我使用 Sphinx 为我的 Python 项目生成文档。我需要在文档中描述一些默认值。但我不想将代码中的值复制粘贴到文档字符串，因为它们以后很容易出现分歧。所以问题是：是否可以用它的值代替对常量的引用？

我说的是这样的事情（我已经制定了:py:const_value:指令）：

DEFAULT = 123

class Foo:
   """Default value for something is :py:const_value:`DEFAULT`."""

我想得到这样的文档：

某些东西的默认值为 123。

我尝试搜索，但恐怕 Sphinx 中没有这样的功能，或者“常量替换”不是正确的术语。

如果不可能使用 Sphinx，是否有另一种方法可以避免这种重复？

Answer 1

根据 sphinx 文档（reStructuredText Primer），您可以得到的最接近的似乎是使用使用replace::标记创建的替换。例如：

.. |PI| replace:: 3.1415

The value of PI is |PI|.

这应该产生

The value of PI is 3.14159.

一个可能的替代方法是 python 域指令:py:const:，它插入一个指向值定义的链接，而不是替换实际值。