Python 3.x 如何让Sphinx autoapi显示源代码中的自定义注释

在python项目中，我生成autoapi文档。特殊注释出现在生成的html文件中。 例如，它在最终html页面上工作并显示：

def do_action(self,params):
  """
  This is function to do some cool stuffs.
  Actually it should
  """
  pass

或

不过，我想autoapi生成一些自定义注释到html页面 例如，我在代码中得到了如下注释：

"""These are public variable:"""
p_var1 = "segg"
p_var2 = "fos"

但最后一条评论没有显示在生成的文档中。可能是因为它没有连接到源代码中的任何定义结构？（我指的不是变量声明，也不是函数或类声明）

---

无论如何，应该如何强制sphinx从由三个撇号环绕的任何注释生成html条目？

有两种方法可以让

sphinx

解析变量注释。第一个是通过属性docstrings，在中指定它们属于它们所描述的属性，如第一个示例中所示。虽然被拒绝，但它是

sphinx

正确工作所需的格式：

p_var1=“segg”
“”“p_var1的文档字符串”“”

呈现为：

或者，

sphinx

还将在以冒号开头的属性上方拾取注释，并将其视为docstring，在某些情况下，在源代码中看起来更好一些：

：p#u var1的说明
p_var1=“segg”

也呈现为：

---

---

如果没有附加模块、异常、类、方法、函数或变量，则无法选择拾取注释，因为

autodoc

明确地只考虑信息（和调用签名，但这是唯一的例外）。

很抱歉反应太晚，很好的示例：-）可能一个

p_var3=“pina”

可以帮助跟踪问题的根源，特别是当它是一些html/css问题，或者是一些关于文档生成的问题时。

"""These are public variable:"""
p_var1 = "segg"
p_var2 = "fos"