Configuration

This extension contributes two configuration fields to conf.py.

external_links: Mapping[str, str] = {}

Mapping of case-insensitive external links and the target used to reference them.

external_links = {
    "Google": "https://google.com",  # matches ":link:`google`", ":link:`Google`", etc
}

external_links_detect_hardcoded_links: bool = True

Emit a warning when a hardcoded link can be replaced using the :link: role.

external_links_substitutions: Mapping[str, str] = {}

Mapping of substitutions.

Substitutions are processed after default substitutions like |release|, |version| and |today|, but before any others in source files.

external_links_substitutions = {
    "dict": ":class:`dict`"
}