Question

我一直致力于与Senna接口的项目，Senna是使用Python进行NLP处理的工具。为了便于生成文档，我遵循了reStructuredText文档样式，这非常简单。

在致电make html时，很少时间（有时没有警告）已显示警告，如

pntl.tools.Annotator.test的docstring：2：警告：字段列表没有空行;在工作中显示的这个数字2的用途是什么意外的无意义和另外一件事。

def test(senna_path="/media/jawahar/jon/ubuntu/senna", sent="", dep_model="", batch=False, 
           jar_path="/media/jawahar/jon/ubuntu/practNLPTools-lite/pntl"):
    """please replace the path of yours environment(accouding to OS path)
    :parama str senna_path: path for senna location
    :parama str dep_model: stanford dependency parser model location
    :parama str or list sent: the sentense to process with Senna
    :parama bool batch: makeing as batch process with one or more sentense passing
    :parama str jar_path: location of stanford-parser.jar file
    """

并附加built result的图片以显示html内容中的错误。有关我的项目的详细信息，请按照此link

进行操作

Answer 1

错误表示您的语法不正确，特别是说明和字段列表周围没有空行，并且缩进不正确。白色空间至关重要。

拼写也很重要。你的意思可能是:param blah blah: thing而不是:parama blah blah: thing:

有关详细信息，请参阅Info field lists。

修改

以下示例应解决此问题。请注意“param”的正确拼写，以及将参数列表与docstring中的描述分开的必要换行符。另外，为了避免代码中的PEP8警告（在这种情况下reStructuredText并不真正关心），您应该如方法定义中所述包装长行。参数列表中还有另一个新的换行符，以便Sphinx正确呈现它并避免PEP8警告。

def test(senna_path="/media/jawahar/jon/ubuntu/senna", sent="", dep_model="", batch=False, jar_path="/media/jawahar/jon/ubuntu/practNLPTools-lite/pntl"): """ please replace the path of yours environment(accouding to OS path) :param str senna_path: path for senna location :param str dep_model: stanford dependency parser model location :param str or list sent: the sentense to process with Senna :param bool batch: makeing as batch process with one or more sentense passing :param str jar_path: location of stanford-parser.jar file """

sphinx：来自docstring的html内容中没有内容更新

1 个答案: