PyCharm 2017.2 Help

Python External Documentation

File | Settings | Tools | Python External Documentation for Windows and Linux
PyCharm | Preferences | Tools | Python External Documentation for macOS


Python External Documentation

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.
URL PatternThis 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 .

/help/img/idea/2017.2/add.pngClick this button to add to the list a new module and its URL pattern or local address.
/help/img/idea/2017.2/edit1.pngClick this button to change the name and/or URL pattern of the selected module.
Double-clicking an entry in the table produces same result.
/help/img/idea/2017.2/delete.pngDelete the selected module from the list.

Add/Edit Documentation URL

Module nameType module name in the text field.
URL patternIn this text field, create the desired pattern, using plain text and macros from the Available Macros field.

Note that documentation can also reside locally.

InsertClick this button to add the selected macro to the pattern.
Last modified: 26 October 2017

See Also