Skip to main content

Sphinx extension for easily adding reusable external links.

Project description

sphinxcontrib.external-links

pre-commit renovate

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|.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinxcontrib_external_links-0.1.1.tar.gz (11.3 kB view hashes)

Uploaded Source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page