Add configuration for sphinx.ext.extlinks

khaeru · Jan 10, 2021 · 1232e60 · 1232e60
1 parent c63dec6
commit 1232e60
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -19,6 +19,7 @@
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
+    "sphinx.ext.extlinks",
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
 ]
@@ -43,6 +44,14 @@
 # "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
 
+# -- Options for sphinx.ext.extlinks ---------------------------------------------------
+
+extlinks = {
+    "issue": ("https://github.com/khaeru/genno/issues/%s", "#"),
+    "pull": ("https://github.com/khaeru/genno/pull/%s", "PR #"),
+    "gh-user": ("https://github.com/%s", "@"),
+}
+
 # -- Options for sphinx.ext.intersphinx ------------------------------------------------
 
 intersphinx_mapping = {