https://github.com/finleyfamily/sphinxcontrib.external-links

Sphinx extension for easily adding reusable external links.
https://github.com/finleyfamily/sphinxcontrib.external-links

sphinx sphinx-extension sphinxcontrib

Last synced: 4 months ago
JSON representation

Sphinx extension for easily adding reusable external links.

• Host: GitHub
• URL: https://github.com/finleyfamily/sphinxcontrib.external-links
• Owner: finleyfamily
• License: apache-2.0
• Created: 2024-03-27T18:21:53.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2025-03-24T03:38:28.000Z (4 months ago)
• Last Synced: 2025-03-25T19:49:29.913Z (4 months ago)
• Topics: sphinx, sphinx-extension, sphinxcontrib
• Language: Python
• Homepage: https://sphinxcontribexternal-links.readthedocs.io
• Size: 1.15 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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/github/finleyfamily/sphinxcontrib.external-links)

[![pypi](https://img.shields.io/pypi/v/sphinxcontrib.external-links?style=flat)](https://pypi.org/project/sphinxcontrib.external-links/)

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

This thing is a |dict|.

```