online_help

scikitplot.online_help(query='', docs_root_url='https://scikit-plots.github.io/', search_page='search.html', new_window=0)

Open the online documentation search page for a given query in the default web browser.

This function constructs a search URL based on the provided query and opens it in the web browser. It detects whether the version is in development or stable state and directs the user to the appropriate documentation.

Parameters:

querystr, optional

The search query to find relevant documentation. Defaults to an empty string.

docs_root_urlstr, optional

The base URL of the documentation website. Defaults to https://scikit-plots.github.io/.

search_pagestr, optional

The search page URL (relative to docs_root_url). Defaults to search.html.

new_windowint, optional

Controls how the URL is opened in the browser:

• 0: Open in the same browser window.

• 1: Open in a new browser window.

• 2: Open in a new browser tab.

Returns:

bool

Returns True if the browser was successfully launched, False otherwise.

Parameters:

• query (str)

• docs_root_url (str)

• search_page (str)

• new_window (int)

Return type:

bool

Notes

• The function automatically switches between the ‘dev’ and ‘stable’ versions of the documentation based on the value of __version__.

• Requires an active internet connection.

• If the environment variable DOCS_ROOT_URL is set, it overrides the docs_root_url argument.

Examples

>>> import scikitplot
>>> scikitplot.online_help('installation')

False

Make live