Open external links in new tabs of the browser in Sphinx HTML documents
Project description
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="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",
]
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
Enjoy documentation!🙌
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for sphinx_new_tab_link-0.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b7b84e97c618c0d2033d6d559db7b36ead2ab90c1c84761c686fe845e479e93 |
|
MD5 | e61fbc2fc0138be2d9483afd5e8eb2ad |
|
BLAKE2b-256 | 9037dab34f66d138cf474e137dfc0a06b2f3231f31ffe78960840d4c105a1bbc |
Close
Hashes for sphinx_new_tab_link-0.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5fd974e510dadcf42232da1174541b9f2918cc77d55dce8a72e02d97cb21da92 |
|
MD5 | 3fa1ec197c9f93c1227308da62d7bf93 |
|
BLAKE2b-256 | d8e93653fa1d754b029bd976cad267b14745b87eab5359d5a441945bc01548ef |