Python PyCharm和StructuredText(Sphinx)文档弹出窗口

Python PyCharm和StructuredText(Sphinx)文档弹出窗口,python,pycharm,python-sphinx,epydoc,Python,Pycharm,Python Sphinx,Epydoc,让我们想象一下,我想在PyCharm4.5社区版(也在5.0中尝试过)中看到一个简单方法的docstring弹出窗口 我用epytext语法(Epydoc生成器自2008年以来不受支持,仅适用于Python2)和StructuredText语法(Sphinx使用该语法-积极支持的生成器,用于官方python文档)记录了这些文档字符串 epytext one可以在PyCharm文档弹出窗口中完美工作 但是重构后的文本一点也不显示任何参数 试图通过PyCharm设置处理这个问题,阅读PyChar

让我们想象一下,我想在PyCharm4.5社区版(也在5.0中尝试过)中看到一个简单方法的docstring弹出窗口

我用epytext语法(Epydoc生成器自2008年以来不受支持,仅适用于Python2)和StructuredText语法(Sphinx使用该语法-积极支持的生成器,用于官方python文档)记录了这些文档字符串

epytext one可以在PyCharm文档弹出窗口中完美工作

但是重构后的文本一点也不显示任何参数

试图通过PyCharm设置处理这个问题,阅读PyCharm帮助,搜索PyCharm bugtracker并使用Google无法帮助我找到PyCharm中的这些docstring弹出窗口不能正确使用社区推荐的docstring标记语言的原因

这是因为对该功能的需求较低吗?也许,在PyCharm或其他IDE中是否有一些有用的替代方法来查看现代文档标记?我还需要能够生成HTML格式的文档页面

我在这里发现了与同一问题有关的问题,但自去年以来仍然没有答案。所以,我猜我想在现代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

我不知道这个功能是否只出现在最近的PyCharm版本中,那么您有什么版本?在我的PyCharm CE 2016.2.2中,它在屏幕截图上看起来像

检查首选项>编辑器>常规>代码完成,确保启用了选项“Autotop documentation”


祝你好运

多谢各位!奇怪的是,如果从pycharm网站下载2016.1版的话,这项功能目前仍然有效,而我的同事几个月前安装的那项功能就不行了!IDK确切的原因是,可能所有THSE版本都有一个最新的补丁(我测试了5.0.2和5.0.5,最新的一个也可以使用这个功能!)