Web browser plugin for Ginga.

Plugin Type: Global

WBrowser is a global plugin. Only one instance can be opened.


This global plugin is used to browse help pages for Ginga.

When a “Help” button is pressed from a plugin (e.g., Pick), Ginga will attempt to download an existing documentation build from ReadTheDocs for the matching version. If successful, plugin documentation from that download is displayed. If not successful or deliberately disabled in “plugin_WBrowser.cfg”, Ginga will render the plugin’s docstring locally.

It is customizable using ~/.ginga/plugin_WBrowser.cfg, where ~ is your HOME directory:

# WBrowser plugin preferences file
# Place this in file under ~/.ginga with the name "plugin_WBrowser.cfg"

# Set to True to force offline doc browsing, otherwise download from RTD
offline_doc_only = False