sphinx_gallery.docs_resolv¶
Link resolver objects¶
Functions¶
- sphinx_gallery.docs_resolv.embed_code_links(app, exception)[source]¶
Embed hyperlinks to documentation into example code
Classes¶
- class sphinx_gallery.docs_resolv.SphinxDocLinkResolver(config, doc_url, gallery_dir, relative=False)[source]¶
Resolve documentation links using searchindex.js generated by Sphinx
- Parameters
- resolve(cobj, this_url, return_type=False)[source]¶
Resolve the link to the documentation, returns None if not found
- Parameters
cobj (dict) – Dict with information about the “code object” for which we are resolving a link. cobj[‘name’] : function or class name (str) cobj[‘module_short’] : shortened module name (str) cobj[‘module’] : module name (str)
this_url (str) – URL of the current page. Needed to construct relative URLs (only used if relative=True in constructor).
return_type (bool) – If True, return the type as well.
- Returns
link (str or None) – The link (URL) to the documentation.
type_ (str) – The type. Only returned if return_type is True.