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
Close
Hashes for sphinxcontrib_external_links-0.1.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 506c431bab8d689219d06bf9c1cc6c5bda06165eca86b0a679feda6c41f80bc0 |
|
| MD5 | d6f0f0049e9f913b2e9e030e4f892513 |
|
| BLAKE2b-256 | 7c7776ac2e04f567e2c3ddd9be3483d003a8089169b453f39078036c805bc806 |
Close
Hashes for sphinxcontrib_external_links-0.1.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 58a59f928496745b0cdfa32a4a57f6372d783dc866f6db58e469ab8bf2dd46c2 |
|
| MD5 | e55e7a572bbc401e10c009ed556545b3 |
|
| BLAKE2b-256 | ab9828aac83bcb6a76844963ba3e70e32be0940eed6002abcc3015026b8809d2 |
