Help

class pyedb.generic.general_methods.Help

Overview

Methods

search	Search for one or more keywords.
getting_started	Open the PyEDB User guide page.
examples	Open the PyEDB Examples page.
github	Open the PyEDB GitHub page.
changelog	Open the PyEDB GitHub Changelog for a given release.
issues	Open the PyEDB GitHub Issues page.
ansys_forum	Open the PyEDB GitHub Issues page.
developer_forum	Open the Discussions page on the Ansys Developer site.

Attributes

browser

Import detail

from pyedb.generic.general_methods import Help

Attribute detail

Help.browser = 'default'

Method detail

Help.search(keywords, app_name=None, search_in_examples_only=False)

Search for one or more keywords.

Parameters:

keywordsstr or list

app_namestr, optional

Name of a PyEDB app.

search_in_examples_onlybool, optional

Whether to search for the one or more keywords only in the PyEDB examples. The default is False.

Help.getting_started()

Open the PyEDB User guide page.

Help.examples()

Open the PyEDB Examples page.

Help.github()

Open the PyEDB GitHub page.

Help.changelog(release=None)

Open the PyEDB GitHub Changelog for a given release.

Parameters:

releasestr, optional

Release to get the changelog for. For example, "0.6.70".

Help.issues()

Open the PyEDB GitHub Issues page.

Help.ansys_forum()

Open the PyEDB GitHub Issues page.

Help.developer_forum()

Open the Discussions page on the Ansys Developer site.