| Name | sphinx-new-tab-link JSON |
| Version |
0.6.0
JSON |
| download |
| home_page | None |
| Summary | Open external links in new tabs of the browser in Sphinx HTML documents |
| upload_time | 2024-09-04 15:16:12 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | MIT License |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# sphinx-new-tab-link
[](https://badge.fury.io/py/sphinx-new-tab-link)
[](https://pypi.org/project/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
```rst
External link: `Example <https://example.com/>`_
```
is converted into
```html
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.
```python
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`.
```python
new_tab_link_show_external_link_icon = True
```
## Roles
### External link with icon (Experimental)
```rst
External link: :icon-link:`Example <https://example.com/>`
```
Enjoy documentation!🙌
Raw data
{
"_id": null,
"home_page": null,
"name": "sphinx-new-tab-link",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "nikkie <takuyafjp+develop@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/05/ab/41a9eaac62a0bc654acf58b82107cb0b8d757480917102e9a81fe0f36141/sphinx_new_tab_link-0.6.0.tar.gz",
"platform": null,
"description": "# sphinx-new-tab-link\n\n[](https://badge.fury.io/py/sphinx-new-tab-link)\n[](https://pypi.org/project/sphinx-new-tab-link/)\n\nOpen external links in new tabs of the browser in Sphinx HTML documents\n\n## Overview\n\nIf you enable `sphinx_new_tab_link`, external links of built HTML are opened in new tabs of your browser.\n\nThe reST\n\n```rst\nExternal link: `Example <https://example.com/>`_\n```\n\nis converted into\n\n```html\nExternal link: <a class=\"reference external\" href=\"https://example.com/\" rel=\"noopener noreferrer\" target=\"_blank\">Example</a>\n```\n\n## Usage\n\nFirst, create your Sphinx documentation.\n\nThen edit `conf.py` to use this extension.\n\n```python\nextensions = [\n \"sphinx_new_tab_link\",\n]\n```\n\n## Configuration\n\n### `new_tab_link_show_external_link_icon`\n\n* Type: `bool`\n* Default: `False`\n\nIf you want to show external links with icons, set this to `True` in your `conf.py`.\n\n```python\nnew_tab_link_show_external_link_icon = True\n```\n\n## Roles\n\n### External link with icon (Experimental)\n\n```rst\nExternal link: :icon-link:`Example <https://example.com/>`\n```\n\nEnjoy documentation!\ud83d\ude4c\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Open external links in new tabs of the browser in Sphinx HTML documents",
"version": "0.6.0",
"project_urls": {
"Bug Tracker": "https://github.com/ftnext/sphinx-new-tab-link/issues",
"Guide": "https://ftnext.github.io/sphinx-new-tab-link/guide.en.html",
"Homepage": "https://github.com/ftnext/sphinx-new-tab-link"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cab5afd72c46ec9eab85cff0f09aacd1cce11f171fe27f763268d90afe21cf87",
"md5": "10b99cbe02b67f56ac144152a52d7660",
"sha256": "3abe9d25bd1f4e898097c71ca1cdbd441bb0159c82376081601181c3b7287479"
},
"downloads": -1,
"filename": "sphinx_new_tab_link-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "10b99cbe02b67f56ac144152a52d7660",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5413,
"upload_time": "2024-09-04T15:16:10",
"upload_time_iso_8601": "2024-09-04T15:16:10.863524Z",
"url": "https://files.pythonhosted.org/packages/ca/b5/afd72c46ec9eab85cff0f09aacd1cce11f171fe27f763268d90afe21cf87/sphinx_new_tab_link-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "05ab41a9eaac62a0bc654acf58b82107cb0b8d757480917102e9a81fe0f36141",
"md5": "2db2c19ba144973edfe718b1210ecc67",
"sha256": "634c92a1132923161c06b5603a74f7041e7dcec9478fe85fd7e464554a717778"
},
"downloads": -1,
"filename": "sphinx_new_tab_link-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "2db2c19ba144973edfe718b1210ecc67",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6003,
"upload_time": "2024-09-04T15:16:12",
"upload_time_iso_8601": "2024-09-04T15:16:12.245960Z",
"url": "https://files.pythonhosted.org/packages/05/ab/41a9eaac62a0bc654acf58b82107cb0b8d757480917102e9a81fe0f36141/sphinx_new_tab_link-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-04 15:16:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ftnext",
"github_project": "sphinx-new-tab-link",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sphinx-new-tab-link"
}
