Sphinx extension for easily adding reusable external links.
Project description
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
linkcheckbuilder 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|.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file sphinxcontrib_external_links-0.1.1.tar.gz.
File metadata
- Download URL: sphinxcontrib_external_links-0.1.1.tar.gz
- Upload date:
- Size: 11.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/6.5.0-1024-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1b982e9fb960b2983e87ce64892f28cd0b4fa918560f8e63426641eb16558812 |
|
| MD5 | 1f46f0bfbc128ea11aafd291a237bfec |
|
| BLAKE2b-256 | a9a6683ce7b4541646764576858fb8afad2ff840f7ecd953dd3ee6c434691541 |
File details
Details for the file sphinxcontrib_external_links-0.1.1-py3-none-any.whl.
File metadata
- Download URL: sphinxcontrib_external_links-0.1.1-py3-none-any.whl
- Upload date:
- Size: 11.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/6.5.0-1024-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d2ec5572179fa004eeec7b5450d2c0bc3e52022c51871b684a7655069a223064 |
|
| MD5 | dab59d7ff626b56338cdf72b00651899 |
|
| BLAKE2b-256 | 1838424a9fbf5919d54171cf23ad68c53a7391feb8308a6908d6b57c5cd96423 |
