2

我正在使用几个 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__ 没有效果。

知道如何使用我自己的文档字符串吗?

4

1 回答 1

0

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

content = ndb.StringProperty()
"The content"

#: the content
content = ndb.StringProperty()
于 2013-07-07T02:26:41.013 回答