python-在狮身人面像文档中打印变量值

假设我有一个模块名称module.py,并且在其中有一个名为_VAR的私有变量,我想在我的狮身人面像文档中打印它的值.

module.py

_VAR = 20

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

index.rst

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

输出将是：

The value of module._VAR is 20

解决方法:

完全可以通过autodoc功能来执行所需的操作.您只需要确保在代码中明确记录了该值,如下所示：

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

然后,您可以通过使用include-private进行自动模块或仅对该变量名进行显式自动数据处理,从而将此值添加到文档中.

请注意,您可以使用相同的策略(#:)显式地记录类的属性,并且它们将显示在自动类(或自动模块的文档中,因为这会隐式地记录该类),包括初始化的所有文字值.至.

标签：python-sphinx,python
来源： https://codeday.me/bug/20191121/2053372.html