semvec/pypi-packages huggingface dataset:
sphinxcontrib.external-links 0.1.1
Sphinx extension for easily adding reusable external links.
License: Apache-2.0
Requires Python: <4.0,>=3.9
Keywords: documentation, extension, sphinx

# sphinxcontrib.external-links

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
[![renovate](https://img.shields.io/badge/enabled-brightgreen?logo=renovatebot&logoColor=%2373afae&label=renovate)](https://developer.mend.io/)

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](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#substitutions)

## Usage

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

```rst
Provide a link to :link:`Google` to :link:`google.com <google>`.
This thing is a |dict|.
```