statsmodels.tools.web.webdoc

statsmodels.tools.web.webdoc(func=None, stable=None)

Open a browser and display online documentation

Parameters:

funcNone, str, or callable, optional

Either a string to search the documentation or a function

stablebool, optional

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

Documentation site

>>> sm.webdoc()

Search for glm in docs

>>> sm.webdoc('glm')

Go to current generated help for OLS

>>> sm.webdoc(sm.OLS, stable=False)