PyCharm和reStructuredText（Sphinx）文档弹出窗口

Question

让我们想象一下，我想在 PyCharm 4.5社区版（也在5.0中尝试过）中看到一个简单方法的文档字符串弹出窗口。

我用 epytext 语法（Epydoc生成器自2008年以来不支持，仅适用于Python2）和 reStructuredText 语法（由Sphinx使用 - 主动）写下这些文档字符串支持的生成器，用于官方python文档）

epytext完美地在PyCharm文档弹出窗口中工作

PyCharm works with epytext Screenshot

但是reStructuredText没有显示任何参数！

PyCharm fails with reStructuredText Screenshot

尝试使用PyCharm设置来处理这个问题，阅读PyCharm会有所帮助，搜索PyCharm bugtracker并使用Google无法帮助我找到PyCharm中这些docstring弹出窗口无法正常使用社区推荐的docstring标记的原因语言。

这是因为该功能需求量低吗？或许，是否有一些有用的替代方法可以在PyCharm或其他IDE中查看现代文档标记？我还需要能够生成HTML格式化的docpages。

我在这里找到another topic，与同一个问题有关，但自去年以来仍然没有答案。所以，我猜想我在现代IDE中查看现代文档的愿望有什么问题。

以下是我的代码示例

def find_links(self, issue, link_type):
    """

    Find all issues linked with C{issue} with C{link_type}.

    @param issue: Issue key
    @type issue: str
    @param link_type: Accepts either Type Name (like 'Child') or Link Description (like 'child of')
    @type link_type: str
    @return: Keys of found issues
    @rtype: list

    """
    result_keys = []
    link_list = self.get_link_list(issue)
    for link in link_list:
        ... # omitted
    return result_keys

def test_sphinx_docs_method(self, issue, link_type):
    """

    Find all issues linked with *issue* with *link_type*.

    :param issue: Issue key
    :type issue: str
    :param link_type: Accepts either Type Name (like 'Child') or Link Description (like 'child of')
    :type link_type: str
    :return: Keys of found issues
    :rtype: list

    """
    result_keys = []
    link_list = self.get_link_list(issue)
    for link in link_list:
        ... # omitted
    return result_keys

Answer 1

我不知道这个功能是否只出现在最近的PyCharm版本中，那么你有什么版本？在我的PyCharm CE 2016.2.2中，它看起来像截图。

检查偏好设置＆gt;编辑＆gt;一般＆gt;代码完成，确保选项“Autopop文档”已启用。

祝你好运！