PyCharm 2021.1 Help

Documentation tool window

The View | Tool Windows | Documentation menu option appears only if you have configured the IDE to display code documentation in a tool window.

Out of the box, PyCharm shows code documentation in a popup as you hover the mouse pointer over symbols in the editor. You can change the view to use the tool window by default: press Ctrl+Q to open the popup and then press Ctrl+Q again.

This tool window is also available in Scientific View.

IconShortcutDescription
the Back button   the Forward buttonLeft or Right

Switch to the previous or go to the next documentation page (for example, after clicking hyperlinks).

On macOS, you can also use the three-finger right-to-left and left-to-right swipe gestures.

the Edit Source buttonF4Navigate to the source code in the editor.
the Show on Mouse Move button

Enable and disable showing code documentation tool window as you hover the mouse over symbols.

When the Show on Mouse Move option is disabled, you have to explicitly open the tool window by pressing Ctrl+Q.

Settings
  • Open as Popup Ctrl+Q: show code documentation in a popup instead of the tool window.

  • Auto-update from Source: when this option is enabled, the content of the tool window changes as you move the mouse pointer in the editor.

    If the Show on Mouse Move option is disabled, place the caret at the symbol to see its documentation in the tool window.

  • Adjust Font Size: display a slider for changing the font size.

  • View Mode: by default, the tool window is attached to the edge of the main window and is always visible. You can change the view mode, for example, to make it visible only when active or to detach it from the tool window bar.

  • Move to: select where to attach the tool window.

  • Resize: adjust the size of the tool window.

  • Remove from Sidebar: close the tool window. To reopen it, select View | Tool Windows | Documentation from the main menu.

Last modified: 08 March 2021