是否可以更改 PyCharm 显示 OpenCV 文档的方式？答案

【问题标题】：Is it possible to change the way PyCharm displays the OpenCV documentation?是否可以更改 PyCharm 显示 OpenCV 文档的方式？
【发布时间】：2020-09-10 12:56:29
【问题描述】：

PyCharm（PY-193.6911.25，macOS 10.15.4）无法正确显示 OpenCV 文档。

更具体地说，这就是结果。

如您所见，这是一团糟。有可能解决这个问题吗？我用 pip 安装了 OpenCV。

【问题讨论】：

标签： python opencv pycharm documentation

【解决方案1】：

在谷歌上搜索了很多之后，我最终认为没有简单的解决方案，但是……确实有！

我所做的是：按 CTRL Q 向下滚动到trippledot，然后单击开源。按 CTRL+R（替换）代替 '。 ' 到 '' 现在 docstring 看起来像这样：绝对不完美，但我认为它看起来更好一些。

此外，我将其添加为外部文档： https://opencv-python-tutroals.readthedocs.io/en/latest/search.html?q={element.name}&check_keywords=yes&area=default

所以它提出了一个 cv2 'tutorial'...

【讨论】：

【解决方案2】：

在带有 Python 3.7 的 PyCharm 2020.1.1 专业版中，cv2 文档字符串显示以下警告
- You need configured Python 2 SDK to render Epydoc docstrings
Epydoc 是一个用于为 Python 模块生成 API 文档的工具，基于它们的文档字符串。
Pycharm can't render Epydoc docstrings
- 在 IDE 中配置的解释器中查找合适的解释器（它必须是 Python 2，因为 Epydoc 包本身尚未移植到 Python 3）。换句话说，您需要设置一次，以便它显示在 Settings | 的列表中。项目：... |项目口译员 | Show All...——它不需要在任何项目中实际使用。你的情况是这样吗？
- 问题在于它不是真正的 Epytext。 OpenCV 将 Doxygen 用于我们不支持的文档，并且由于标签的相似性而与 Epytext 混淆。有一个关于它的open issue。
Doxygen is confused with Epydoc and displayed as free text (not preformatted)
- 恐怕 PyCharm 的这一特殊功能目前还不能真正扩展。此外，显示文档、在其中注入对符号的引用、完成可用标签和生成文档存根——一切都与 Python 代码文档通常通过指定的字符串文字而不是 cmets 提供的事实密切相关。如果您在 ID 为 pythonDocumentationProvider 的默认 API 之前注册了自己的 API，那么您可以插入的最高级别 API 为快速文档弹出/工具窗口提供自定义文档源是 com.intellij.lang.documentation.DocumentationProvider。但它只涉及渲染，其他一切都需要从头开始编写。
官方决议是我们不支持

【讨论】：