get_asset_path

documenteer.conf.utils.get_asset_path(name)

Get the absolute path for a static asset contained in Documenteer’s assets directory, for use with Sphinx’s html_static_path.

Parameters:

name (str) – The name of a path or directory in Documenteer’s assets.

Returns:

absolute_path – An absolute path to the file or directory that can be used in the html_static_path Sphinx configuration list.

Return type:

str

Examples

html_static_path: List[str] = [
    get_asset_path("rubin-titlebar-imagotype-dark.svg"),
    get_asset_path("rubin-titlebar-imagotype-light.svg"),
]