You can use the Help pane to find, render and display rich documentation for any object with a docstring, including modules, classes, functions and methods. Help can be retrieved both by static analysis of open files in the Editor, or by dynamically inspecting an object in an IPython Console.
You can trigger help by manually entering the object’s name into the Object box, pressing the configurable help shortcut (Ctrl-I by default), or even automatically if desired when on typing a left parenthesis (() after a function or method name. Automatic help can be individually enabled for both the Editor and the Console under Preferences ‣ Help ‣ Automatic Connections, and turned on and off dynamically via the lock icon in the top right corner of the Help pane.
(
You can use the options menu (Gear icon) in the top right of the Help pane to toggle the help display mode.
Rich Text mode renders the object’s docstrings with Sphinx:
Sphinx
Plain Text mode displays the docstring without formatting:
Show Source displays the docstring inline with the code for the selected object, or any Python portion of it (if the object is not pure Python). This can be useful when docstrings are not available or insufficient to document the object:
Editor
IPython Console
Online Help
