sphinx：没有从docstring的内容更新HTML内容

Question

我一直在努力与Senna交互，这是在使用Python的NLP处理中使用的工具。为了便于生成文档，我使用了reStructuredText文档样式，这非常简单。

在调用make html，很少时间（并且有时没有警告）已经示出像pntl.tools.Annotator.test的

文档字符串警告：2：警告：字段列表结束，而不一个空行意外的unindent和另外一件事情是什么是使用这个数字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。

编辑

下面的例子应该可以解决这个问题。请注意“参数”的正确拼写，以及将参数列表与文档字符串中的描述分开的必要换行符。另外，为了避免代码中出现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 
    """