doclink#
- doclink(name: str, default_link: Optional[str] = None, template: Optional[str] = None, package_version: str = '0.18.1') str[source]#
Get documentation link.
- Parameters
- name: str
the name of the required link as appears in the links’ dictionary.
- default_link: t.Optional[str], default: None
default like to use if no link corresponding to name was found.
- template: t.Optional[str], default: None
a string template in which to incorporate the link.
- package_version: str
which version of the docs to use
- Returns
- str
The template text incorporated with the relevant link