sphinx-new-tab-link

testing workflow

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!🙌

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_new_tab_link-0.8.2.tar.gz (7.8 kB view details)

Uploaded Aug 26, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

sphinx_new_tab_link-0.8.2-py3-none-any.whl (6.2 kB view details)

Uploaded Aug 26, 2026 Python 3

File details

Details for the file sphinx_new_tab_link-0.8.2.tar.gz.

File metadata

Download URL: sphinx_new_tab_link-0.8.2.tar.gz
Upload date: Aug 26, 2026
Size: 7.8 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for sphinx_new_tab_link-0.8.2.tar.gz
Algorithm	Hash digest
SHA256	`8a339fbfcb1712db8eb3d503c61b86da11a52f1216bd308d6f6dcec6139dd8ea`
MD5	`4a4fbcbec3bf2df9505cf4a2049e94d8`
BLAKE2b-256	`d2b9ee505f904abefa6b574736c93813275a22821933cf2293c83893107eecb6`

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_new_tab_link-0.8.2.tar.gz:

Publisher: publish.yml on ftnext/sphinx-new-tab-link

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: sphinx_new_tab_link-0.8.2.tar.gz
- Subject digest: 8a339fbfcb1712db8eb3d503c61b86da11a52f1216bd308d6f6dcec6139dd8ea
- Sigstore transparency entry: 2602748622
- Sigstore integration time: Aug 26, 2026
Source repository:
- Permalink: ftnext/sphinx-new-tab-link@799804c7f5f34134ceb3d763ebdfc967c55aaf07
- Branch / Tag: refs/tags/v0.8.2
- Owner: https://github.com/ftnext
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@799804c7f5f34134ceb3d763ebdfc967c55aaf07
- Trigger Event: release