IntelliJ IDEA 2018.2 Help

Python External Documentation

File | Settings | Tools | Python External Documentation for Windows and Linux
IntelliJ IDEA | Preferences | Tools | Python External Documentation for macOS
Ctrl+Alt+S icons general settings svg

Python External Documentation



Module Names

This 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.

URL Pattern

This column shows existing patterns of the URLs to the external documentation, or its local address.

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

icons general add

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

icons actions edit svg

Click this button to change the name and/or URL pattern of the selected module.
Double-clicking an entry in the table produces same result.

icons general remove svg

Delete the selected module from the list.

Add/Edit Documentation URL



Module name

Type 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.

Note that documentation can also reside locally.


Click this button to add the selected macro to the pattern.

Last modified: 20 November 2018