sphinx:No 文档字符串 html 内容更新

Question

我一直在做一个与 Senna 交互的项目，Senna 是使用 Python 进行 NLP 处理的工具。为了轻松生成文档，我遵循了非常简单的 reStructuredText 文档样式。

在调用 make html 时，有几次（有时没有警告）显示

之类的警告

docstring of pntl.tools.Annotator.test:2: WARNING: Field list ends without a blank line; unexpected unindent and one more thing what is the use of this number 2 displayed in the working.

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 is been attach to show error in the content of html. For detail view of my project follow this link

的图片

Answer 1

该错误表明您的语法不正确，特别是描述和字段列表周围没有空行，并且缩进不正确。白色 space 很重要。

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

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

编辑

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

sphinx:No content update in html content from docstring

python-sphinx