81. gui.menus.Help
— Display help¶
81.1. Functions defined in module gui.menus.Help¶
- gui.menus.Help.buildHtmlDocs(builddir=None)[source]¶
Build the html documentation.
Note: this is only for users building the docs. Builds at installation time are done by the Makefile. builddir is where the docs are built. For ‘G’ this is pyformex/doc/. For ‘RD’ this is .local/share/pyformex/doc/html.
- gui.menus.Help.searchIndex()[source]¶
Search text in pyFormex refman index.
Asks a pattern from the user and searches for it the index of the local pyFormex documentation. Displays the results in the browser.
- gui.menus.Help.searchText()[source]¶
Search text in pyFormex source files.
Asks a pattern from the user and searches for it through all the pyFormex source files.
- gui.menus.Help.catchAndDisplay(expression)[source]¶
Catch stdout from a Python expression and display it in a window.
- gui.menus.Help.showLocalURL(filename)[source]¶
Show a html document in the local html dir.
- Parameters:
filename (str) – Path of the file relative to pf.cfg[‘htmldir’]
- gui.menus.Help.install_external(pkgdir, prgname)[source]¶
Install external software from the pyformex/extra dir
- gui.menus.Help.showHelp(action)[source]¶
Function triggered by the help menu items.
If the action’s data is a tuple with a callable as first item, call it with the remainder of the tuple as arguments.
- gui.menus.Help.menu_func(action)¶
Function triggered by the help menu items.
If the action’s data is a tuple with a callable as first item, call it with the remainder of the tuple as arguments.