Skip to main content

Open external links in new tabs of the browser in Sphinx HTML documents

Project description

sphinx-new-tab-link

testing workflow PyPI version Python Versions

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="noopener noreferrer" target="_blank">Example</a>

Usage

First, create your Sphinx documentation.

Then edit conf.py to use this extension.

extensions = [
    "sphinx_new_tab_link",
]

Enjoy documentation!🙌

Project details


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.3.0.tar.gz (4.3 kB view details)

Uploaded Source

Built Distribution

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

sphinx_new_tab_link-0.3.0-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page