在 sphinx 文档中打印变量值

Question

想象我有一个模块名称module.py，在它里面，我有一个名为 的私有变量_VAR，我想在我的 sphinx 文档中打印它的值。

module.py

_VAR = 20

在狮身人面像中，我想要这样的东西：

index.rst

The value of ``module._VAR`` is :py:print:`module._VAR`

输出将是：

The value of module._VAR is 20

Answer 1

通过autodoc功能完全可以做你想做的事情。您只需要确保该值明确记录在代码中，如下所示：

_VAR = 20 #: Notice the colon, this tells sphinx to use this comment as docstring for this value

automodule然后，您可以通过使用include-private或仅在该变量名称上显式执行操作来将该值添加到文档中autodata。

请注意，您可以使用相同的策略 ( #:) 来显式记录类的属性，并且它们将显示在文档中autoclass（或者automodule因为隐式地记录类），包括它们初始化为的任何文字值。