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

Question

所以我一直在尝试为我的项目制作一些文档。我找到了 Sphinx，它看起来很棒，所以我选择了它。现在，我正在尝试使用它的自动文档功能，但是，它不能正常工作。起初，我认为这是因为我的文档字符串不是第一种样式，但是，它们是。

例如，这是 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。

我的结果如下所示：

我希望自动文档看起来更接近 python-twitter API 文档中可用的内容，例如：

有谁知道会发生什么？提前致谢！

标签： pythonpython-sphinxrestructuredtext