Sphinx文档不断替换

Question

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

我在谈论这样的事情（我已经制定了: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:，它插入一个指向值定义的链接，而不是替换实际值。