bundles / astropy latest / astropy / utils / misc / find_api_page
function
astropy.utils.misc:find_api_page
source: /astropy/utils/misc.py:168
Signature
def find_api_page(obj, version = None, openinbrowser = True, timeout = None)Summary
Determines the URL of the API page for the specified object, and optionally open that page in a web browser.
Extended Summary
Parameters
objThe object to open the docs for or its fully-qualified name (as a str).
version: strThe doc version - either a version number like '0.1', 'dev' for the development/latest docs, or a URL to point to a specific location that should be the base of the documentation. Defaults to latest if you are on aren't on a release, otherwise, the version you are on.
openinbrowser: boolIf True, the webbrowser package will be used to open the doc page in a new web browser window.
timeout: number, optionalThe number of seconds to wait before timing-out the query to the astropy documentation. If not given, the default python stdlib timeout will be used.
Returns
url: strThe loaded URL
Raises
: ValueErrorIf the documentation can't be found
Aliases
astropy.find_api_page