如何在 Pycharm 中显示官方 sphinx 示例和模块文档
[英]How to show official sphinx examples and documentation of modules in Pycharm
问题描述
I am looking at a builtin package that is unfamiliar to me : csv (I usually use either pandas.read_csv or numpy.gettext ).
我正在查看一个我不熟悉的内置包： csv （我通常使用pandas.read_csv或numpy.gettext ）。 Is there a quick documentation feature in pycharm to show official sphinx docs for a module? pycharm是否有快速文档功能来显示模块的官方sphinx文档？ I tried opening the csv builtin source and right clicking and see this我尝试打开csv内置源并右键单击并查看此内容
There does not seem to be any documentation related links in there.那里似乎没有任何与documentation相关的链接。
1 个解决方案
解决方案1
0 已采纳 2020-09-06 13:42:08
Quick Documentation快速文档
I tried a general search for documentation in Pycharm Search for any .我尝试了通用搜索documentation中Pycharm Search for any 。 The most relevant (first two) hits最相关的（前两个）点击
The Show Documentation goes to the main page of python docs - which is not the context-sensitive information being sought. Show Documentation转到python docs主页 - 这不是正在寻找的上下文敏感信息。
The Quick Documentation - either CTL-J or View|Quick Documenation - *is* what I was seeking. The most effective method is to select the module name in the header and then hit Quick Documentation - CTL-J或View|Quick Documenation - *is* what I was seeking. The most effective method is to select the module name in the header and then hit View|Quick Documenation - *is* what I was seeking. The most effective method is to select the module name in the header and then hit CTL-J . In the View|Quick Documenation - *is* what I was seeking. The most effective method is to select the module name in the header and then hit CTL-J . In the . In the csv module I selected csv`: . In the csv module I selected csv`：
A pop-up shows: notice at the bottom the link to the specific module on csv.org :弹出窗口显示：注意底部指向 csv.org 上特定模块的链接：
Clicking on that link brings us to where we wanted to go:单击该链接会将我们带到我们想去的地方：
声明:本站的技术帖子网页，遵循CC BY-SA 4.0协议，如果您需要转载，请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.