简体   繁体   中英

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 ). Is there a quick documentation feature in pycharm to show official sphinx docs for a module? I tried opening the csv builtin source and right clicking and see this

在此处输入图片说明

There does not seem to be any documentation related links in there.

Quick Documentation

I tried a general search for documentation in 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.

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 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`:

在此处输入图片说明

A pop-up shows: notice at the bottom the link to the specific module on csv.org :

在此处输入图片说明

Clicking on that link brings us to where we wanted to go:

在此处输入图片说明

The technical post webpages of this site follow the CC BY-SA 4.0 protocol. If you need to reprint, please indicate the site URL or the original address.Any question please contact:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM