Skip to content

finleyfamily/sphinxcontrib.external-links

Repository files navigation

sphinxcontrib.external-links

pre-commit renovate pypi

Sphinx extension for easily adding reusable external links.

Features

  • default list of commonly used external links
  • user configurable links
  • check documentation for hardcoded links that can be replaced
  • compatible with the Sphinx's linkcheck builder to check link integrity
  • global substitutions

Usage

external_links = {
    "Google": "https://google.com",  # matches ":link:`google`", ":link:`Google`", etc
}
external_links_substitutions = {
    "dict": ":class:`dict`",
}
Provide a link to :link:`Google` to :link:`google.com <google>`.
This thing is a |dict|.