sphinx-new-tab-link
Open external links in new tabs of the browser in Sphinx HTML documents
Overview
If you enable sphinx_new_tab_link, external links of built HTML are opened in new tabs of your browser.
Images that link to external pages become slightly brighter when hovered or focused, making it easier to recognize that they are clickable.
The reST
External link: `Example <https://example.com/>`_
is converted into
External link: <a class="reference external" href="https://example.com/" rel="noreferrer" target="_blank">Example</a>
Usage
First, create your Sphinx documentation.
Then edit conf.py to use this extension.
extensions = [
"sphinx_new_tab_link",
]
Configuration
new_tab_link_show_external_link_icon
- Type:
bool - Default:
False
If you want to show external links with icons, set this to True in your conf.py.
new_tab_link_show_external_link_icon = True
new_tab_link_enable_referrer
- Type:
bool - Default:
False
If you want external links without rel="noreferrer", set this to True in your conf.py.
new_tab_link_enable_referrer = True
Roles
External link with icon (Experimental)
External link: :icon-link:`Example <https://example.com/>`
Enjoy documentation!🙌
1 maintainer
Metadata
1 maintainer
Release files for sphinx-new-tab-link 0.8.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_new_tab_link-0.8.2.tar.gz | 7.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_new_tab_link-0.8.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 14.0 kB
Release files / sphinx_new_tab_link-0.8.2.tar.gz
| Download URL | sphinx_new_tab_link-0.8.2.tar.gz |
|---|---|
| Size | 7.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8a339fbfcb1712db8eb3d503c61b86da11a52f1216bd308d6f6dcec6139dd8ea
|
|
BLAKE2b-256 checksum How to use checksums |
d2b9ee505f904abefa6b574736c93813275a22821933cf2293c83893107eecb6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 26, 2026.
Transparency logRelease files / sphinx_new_tab_link-0.8.2-py3-none-any.whl
| Download URL | sphinx_new_tab_link-0.8.2-py3-none-any.whl |
|---|---|
| Size | 6.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c347d2a228d24f522d8b2c7e9aa453fcea87cfc0a98f50617a4dac702e9e3f9f
|
|
BLAKE2b-256 checksum How to use checksums |
6567ff27727d2a27dcd8e7c5a3fc27102aacd2063dbb33364d4ad245bd915266
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 26, 2026.
Transparency log
