pymel.core.system.showHelp

showHelp(*args, **kwargs)

Invokes a web browser to open the on-line documentation and help files. It will open the help page for a given topic, or open a browser to a specific URL. In query mode, return type is based on queried flag.

Flags:

Long name (short name)		Argument Types	Properties
absolute (a)		bool
	The specified “URL” is an absolute URL that should be passed directly to the web browser.
docs (d)		bool
	Use this flag to directly specify a help file relative to the on-line documentation root.
helpTable (ht)		bool
	Use this flag to specify which file will be used to search for help topics when the -d/docs and -a/absolute flags are not used. If only a file name is specified and not a path, then the file is assumed to be in the maya application directory.If this flag does not accept an argument if it is queried.The default value is “helpTable”.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.showHelp

Example:

import pymel.core as pm

# View the documentation for the launchBrowser command
#
pm.showHelp( 'Commands/showHelp.html', docs=True )
# Result: u'http://download.autodesk.com/global/docs/maya2014/en_us/Commands/showHelp.html' #
# View the Autodesk home page
#
pm.showHelp( 'http://www.autodesk.com/', absolute=True )
# Result: u'http://www.autodesk.com/' #
# Query for the full path to the help page on the Align Tool
#
pm.showHelp( 'AlignTool', q=True )
# Result: u'http://download.autodesk.com/global/docs/maya2014/en_us/files/Modify__Align_Tool.htm' #
# Set the help lookup-table to $MAYA_APP_DIR/customHelpTable
#
pm.showHelp( 'customHelpTable', helpTable=True )
# View the help topic "Particle" found in customHelpTable.dat
#
pm.showHelp( 'Particle' )