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.

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