find_api_page(obj, version=None, openinbrowser=True, timeout=None)
You must be connected to the internet for this to function even if openinbrowser
is :None:None:`False`, unless you provide a local version of the documentation to version
(e.g., file:///path/to/docs
).
The object to open the docs for or its fully-qualified name (as a str).
The 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.
If :None:None:`True`, the webbrowser
package will be used to open the doc page in a new web browser window.
The 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.
If the documentation can't be found
The loaded URL
Determines the URL of the API page for the specified object, and optionally open that page in a web browser.
Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.
Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)
SVG is more flexible but power hungry; and does not scale well to 50 + nodes.
All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them