Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Showing documentation in PyCharm

Tags:

pycharm

Im new to python, but Im well familiar with other JetBrains IDE. I want to read NumPy documentation in PyCharm. after pressing ctrl+Q I get a suggestion to open external documentation, instead of providing me the existing one. How do I get PyCharm to display documentation in popup instead of suggesting me external link?

Image below shows what happens now when I press ctrl+Q on NumPy method "where". IDe suggest open external documentation, although documentation is right there visible on a screen and available. externaldocumentation

like image 991
Dovydas Giršvaldas Avatar asked Sep 22 '19 21:09

Dovydas Giršvaldas


1 Answers

Not sure why it doesn't default to loading the local module docstring in this case. However you can load external docs inline by adding patterns to PyCharm to tell it where to find external documentation for a given module.

  1. Go to Settings > Tools > Python External Documentation
  2. Click Add (+) Button to add a new module to the list
  3. Set module name: numpy, URL/Path Pattern: https://docs.scipy.org/doc/numpy/reference/generated/{element.qname}.html
  4. Click Ok and Apply
  5. Now when you look up numpy docs you get everything inline

Visual for the steps I mention how it looks when you do quick docs

like image 176
Rach Sharp Avatar answered Sep 18 '22 11:09

Rach Sharp