PyCharm 2020.3 Help

External Documentation

File | Settings | Tools | External Documentation for Windows and Linux
PyCharm | Preferences | Tools | External Documentation for macOS
Ctrl+Alt+S the Settings/Preferences icon

External Documentation

To view Python external documentation, you need to configure the documentation URL first. PyCharm comes with the URLs for pandas, wx, kivy, PySide, PyQt5, PyQt4, matplotlib, pyramid, flask, and gtk. You can modify the predefined set of URLs or add a new one in the project Settings/Preferences.

Configuring external documentation

Refer to Configure External Documentation for more details.

Module NamesThis column shows the names of the modules, whose documentation you want to have visible in browser on invoking View | External Documentation, or pressing Shift+F1, for example, pandas.
URL Pattern

This column shows existing patterns of the URLs to the external documentation, or its local address, for example,{element.qname}.html

If external documentation resides locally, specify the local path to it .

the Add button

Click this button to add to the list a new module and its URL pattern or local address.

the Edit buttonClick this button to change the name or URL pattern of the selected module.
Double-clicking an entry in the table produces same result.
the Remove buttonDelete the selected module from the list.

Add/Edit Documentation URL

Module nameType module name in the text field.
URL pattern

In this text field, create the desired pattern, using plain text and macros from the Available Macros field.

Modifying the URL for the matplotlib documentation

Note that each documentation module has its specific structure, so be careful when adding macros.

InsertClick this button to add the selected macro to the pattern.
Last modified: 08 March 2021