Skip to content

Commit d5b9eb7

Browse files
zerothijsquyres
authored andcommitted
doc: improved DOI handling for URLS
Direct links to papers should preferably be done using DOI links. Publishers may (at will) change their URLs but they *will* obey doi.org/<doi> links meaning that links to published articles with DOI's will always be stable using: doi.org/<doi> links. I uncovered this link by doing make linkcheck which caused problems for the changed link (in feature/ulmf). Signed-off-by: Nick Papior <nickpapior@gmail.com>
1 parent b5eba4e commit d5b9eb7

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

docs/conf.py

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,11 @@
116116
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
117117
# ones.
118118
import sphinx_rtd_theme
119-
extensions = ['recommonmark', "sphinx_rtd_theme"]
119+
extensions = [
120+
'recommonmark',
121+
"sphinx_rtd_theme",
122+
"sphinx.ext.extlinks",
123+
]
120124

121125
# Add any paths that contain templates here, relative to this directory.
122126
templates_path = ['_templates']
@@ -139,6 +143,14 @@
139143
# so a file named "default.css" will overwrite the builtin "default.css".
140144
#html_static_path = ['_static']
141145

146+
147+
# Short hand external links
148+
# Allows smoother transitioning for commonly used articles and sites
149+
extlinks = {
150+
'doi': ('https://doi.org/%s', '%s'),
151+
}
152+
153+
142154
# -- Options for MAN output -------------------------------------------------
143155

144156
import os

docs/features/ulfm.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ please use:
107107
J. Dongarra: Post-failure recovery of MPI communication
108108
capability: Design and rationale. IJHPCA 27(3): 244-254 (2013).*
109109

110-
Available from: https://journals.sagepub.com/doi/10.1177/1094342013488238.
110+
Available from: :doi:`10.1177/1094342013488238`.
111111

112112
Building ULFM support in Open MPI
113113
---------------------------------

0 commit comments

Comments
 (0)