Sphinx无法正确解析第一个文档字符串

时间:2018-09-23 13:29:30

标签: python python-sphinx restructuredtext

因此,我一直在尝试为我的项目制作一些文档。我找到了狮身人面像,看起来很棒,所以我选择了它。现在,我正在尝试使用其autodoc函数,但是它无法正常工作。起初,我以为是因为我的文档字符串不是第一种样式,但是确实如此。

例如,这是parse_data函数的文档字符串:

    """
    Parse the data as GET parameters and return it.
    :param data: A dictionary containing values for the api call.
    :type data dict
    :return: A proper GET param string
    :rtype str
    """

这是我的.rst文件:

API
===

.. autoclass:: launchlibrary.Api
   :members:

   .. automethod:: __init__

launchlibrary.Api当然包含parse_data。

我的结果如下:

enter image description here

我希望autodoc看起来更接近python-twitter API文档上的内容,例如:

enter image description here

有人知道会发生什么吗?预先感谢!

0 个答案:

没有答案