1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
# -*- coding: utf-8 -*-
"""Create sphinx roles for referencing the DOI of a published paper.
Extension to add links to DOIs. With this extension you can use e.g.
:doi:`10.1016/S0022-2836(05)80360-2` in your documents. This will
create a link to a DOI resolver
(``https://doi.org/10.1016/S0022-2836(05)80360-2``).
The link caption will be the raw DOI.
You can also give an explicit caption, e.g.
:doi:`Basic local alignment search tool <10.1016/S0022-2836(05)80360-2>`.
:copyright: Copyright 2015 Jon Lund Steffensen. Based on extlinks by
the Sphinx team.
:license: BSD.
"""
from docutils import nodes, utils
from sphinx.util.nodes import split_explicit_title
def doi_role(typ, rawtext, text, lineno, inliner, options=None, content=None):
"""Generate node with DOI hyperlink."""
if options is None:
options = {}
if content is None:
content = []
text = utils.unescape(text)
has_explicit_title, title, part = split_explicit_title(text)
full_url = 'https://doi.org/' + part
if not has_explicit_title:
title = 'DOI:' + part
pnode = nodes.reference(title, title, internal=False, refuri=full_url)
return [pnode], []
def arxiv_role(typ, rawtext, text, lineno, inliner, options=None, content=None):
"""Generate node with arxiv hyperlink."""
if options is None:
options = {}
if content is None:
content = []
text = utils.unescape(text)
has_explicit_title, title, part = split_explicit_title(text)
full_url = 'https://arxiv.org/abs/' + part
if not has_explicit_title:
title = 'arXiv:' + part
pnode = nodes.reference(title, title, internal=False, refuri=full_url)
return [pnode], []
def setup_link_role(app):
"""Add custom roles for doi and arxiv."""
app.add_role('doi', doi_role, override=True)
app.add_role('DOI', doi_role, override=True)
app.add_role('arXiv', arxiv_role, override=True)
app.add_role('arxiv', arxiv_role, override=True)
def setup(app):
"""Define sphinx extension."""
app.connect('builder-inited', setup_link_role)
return {'version': '0.1', 'parallel_read_safe': True}
|
