1.1.8. statsmodels.api.webdoc

statsmodels.api.webdoc(arg=None, stable=None)

Opens a browser and displays online documentation

Parameters:

arg, optional : string or statsmodels function

Either a string to search the documentation or a function

stable, optional : bool

Flag indicating whether to use the stable documentation (True) or the development documentation (False). If not provided, opens the stable documentation if the current version of statsmodels is a release

Notes

By default, open stable documentation if the current version of statsmodels is a release. Otherwise opens the development documentation.

Uses the default system browser.

Examples

>>> import statsmodels.api as sm
>>> sm.webdoc()  # Documention site
>>> sm.webdoc('glm')  # Search for glm in docs
>>> sm.webdoc(sm.OLS, stable=False)  # Go to generated help for OLS, devel