Class: QgsHelp

Helper class for showing help topic URI for the given key.

Help can be stored online, on the local directory or on the intranet server. Location of the QGIS help can be configured in QGIS options. Multiple locations are supported, they will be used in order of preference, from top to bottom.

URI construction takes in account following information:

  • QGIS version

  • language of the QGIS UI

If no help found, default error page with information how to setup help system will be shown.

class qgis.gui.QgsHelp[source]

Bases: object

static helpUrl(key: str | None) → QUrl[source]

Returns URI of the help topic for the given key. If help topic not found, URI of the builtin error page returned.

Parameters:

key (Optional[str]) – key which identified help topic

Return type:

QUrl

static openHelp(key: str | None)[source]

Opens help topic for the given help key using default system web browser. If help topic not found, builtin error page shown.

Parameters:

key (Optional[str]) – key which identified help topic