find_api_page

astropy.utils.misc.find_api_page(obj, version=None, openinbrowser=True, timeout=None)[源代码]

确定指定对象的API页的URL,并可选择在web浏览器中打开该页。

注解

您必须连接到internet才能正常工作,即使 openinbrowserFalse ,除非您向 version (例如, file:///path/to/docs

参数
obj

为其打开文档的对象或其完全限定名(作为str)。

versionSTR

文档版本-可以是“0.1”、“dev”之类的版本号(用于开发/最新文档),也可以是指向应为 base 文件的。如果您使用的不是版本,则默认为最新版本,否则为当前版本。

openinbrowser布尔

如果 True , the webbrowser 包将用于在新的web浏览器窗口中打开文档页。

timeout数字,可选

在对astropy文档的查询超时之前等待的秒数。如果没有给定,将使用默认的python stdlib超时。

返回
urlSTR

加载的URL

加薪
ValueError

如果找不到文件