【问题标题】:Showing documentation in PyCharm在 PyCharm 中显示文档
【发布时间】:2020-01-23 00:06:48
【问题描述】:

我是 python 新手,但我非常熟悉其他 JetBrains IDE。我想阅读 PyCharm 中的 NumPy 文档。按 ctrl+Q 后,我收到打开外部文档的建议,而不是提供现有文档。如何让 PyC​​harm 在弹出窗口中显示文档而不是建议我外部链接?

下图显示了当我在 NumPy 方法“where”上按 ctrl+Q 时会发生什么。 IDe 建议打开外部文档,尽管文档在屏幕上可见并且可用。

【问题讨论】:

    标签: pycharm


    【解决方案1】:

    不知道为什么在这种情况下它不默认加载本地模块文档字符串。但是,您可以通过向 PyCharm 添加模式来告诉它在哪里可以找到给定模块的外部文档,从而内联加载外部文档。

    1. 转到设置 > 工具 > Python 外部文档
    2. 单击添加 (+) 按钮将新模块添加到列表中
    3. 设置模块名称:numpy,URL/路径模式:https://docs.scipy.org/doc/numpy/reference/generated/{element.qname}.html
    4. 点击确定并应用
    5. 现在,当您查找 numpy 文档时,所有内容都内联

    【讨论】:

    • 不再有(截至 2021 年 2 月)
    • 是的,看起来 URL 已经移动了 :(
    • 我认为应该是https://numpy.org/doc/stable/reference/generated/numpy.{element.name}.html,因为where 应该替换{element.name} 以产生https://numpy.org/doc/stable/reference/generated/numpy.where.html。不幸的是,无论使用什么{} 类型,这都不会在 PyCharm 中显示文档。 AFAIK,没有办法看到 PyCharm 实际查询的是什么,看看它是否确实用where 代替了{element.name}
    • 是否仍然没有找到解决方案? :( 我什至注意到,当再次关闭和打开 PyCharm 时,numpy 已从外部文档包中删除,文本再次引用 docs.scipy,也许这是内部保存在某个地方并覆盖了外部文档中写入的内容?
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2020-09-10
    • 2020-01-19
    • 1970-01-01
    • 1970-01-01
    • 2022-07-01
    • 1970-01-01
    • 2015-09-01
    相关资源
    最近更新 更多