Question

我正在使用几个appengine模型和autodoc。但是我找不到任何东西获取要应用的属性的文档的方法。我正在使用NDB并使用Sphinx构建文档。

例如使用模型：

class Greeting(ndb.Model):
  """Models an individual Guestbook entry with content and date."""
  content = ndb.StringProperty()
  date = ndb.DateTimeProperty(auto_now_add=True)

内容的结果文档字符串是

索引属性，其值为有限长度的文本字符串

我尝试了以下方法：

  "The content"
  content = ndb.StringProperty()

  content = ndb.StringProperty()
  "The content"

  #: the content
  content = ndb.StringProperty()

  content = ndb.StringProperty()
  content.__doc__="The content"

  content = ndb.StringProperty(__doc__="the content")

  content = ndb.StringProperty(doc="the content")

他们都没有给出错误或工作 - 我总是得到“索引属性......”。我很惊讶明确设置__doc__无效。

知道如何使用我自己的docstring吗？

Answer 1

答案是Sphinx工作得很好。我正在查看未重建的doc输出的错误副本。这两项工作都是：

content = ndb.StringProperty()
"The content"

#: the content
content = ndb.StringProperty()

Appengine模型属性docstring

1 个答案: