ftnext / sphinx-new-tab-link

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

Home Page:https://ftnext.github.io/sphinx-new-tab-link/guide.html

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

About

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

https://ftnext.github.io/sphinx-new-tab-link/guide.html

License:MIT License


Languages

Language:Python 100.0%