Link source documents to github

dmatos2012 · dmatos2012 · commit 8a348ae837be · 2021-07-19T11:27:30.000+02:00
diff --git a/doc/conf.py b/doc/conf.py
@@ -53,7 +53,6 @@
     'sphinx.ext.inheritance_diagram',
     'sphinx.ext.intersphinx',
     'sphinx.ext.ifconfig',
-    'sphinx.ext.viewcode',
     'IPython.sphinxext.ipython_console_highlighting',
     'IPython.sphinxext.ipython_directive',
     'numpydoc',  # Needs to be loaded *after* autodoc.
@@ -530,3 +529,80 @@ def setup(app):
     else:
         bld_type = 'rel'
     app.add_config_value('releaselevel', bld_type, 'env')
+
+# -----------------------------------------------------------------------------
+# Source code links
+# -----------------------------------------------------------------------------
+link_github = True
+# You can add viewcode extension to build old way with link_github = False
+# extensions.append('sphinx.ext.viewcode')
+if link_github:
+    import re
+    import inspect
+    from os.path import relpath, dirname
+    for name in ['sphinx.ext.linkcode', 'linkcode', 'numpydoc.linkcode']:
+        try:
+            __import__(name)
+            extensions.append(name)
+            break
+        except ImportError:
+            pass
+    else:
+        print("NOTE: linkcode extension not found -- no links to source generated")
+
+    def linkcode_resolve(domain, info):
+        """
+        Determine the URL corresponding to Python object
+        """
+        if domain != 'py':
+            return None
+
+        modname = info['module']
+        fullname = info['fullname']
+
+        submod = sys.modules.get(modname)
+        if submod is None:
+            return None
+
+        obj = submod
+        for part in fullname.split('.'):
+            try:
+                obj = getattr(obj, part)
+            except Exception:
+                return None
+
+        try:
+            fn = inspect.getsourcefile(obj)
+        except Exception:
+            fn = None
+        if not fn:
+            try:
+                fn = inspect.getsourcefile(sys.modules[obj.__module__])
+            except Exception:
+                fn = None
+        if not fn:
+            return None
+
+        try:
+            source, lineno = inspect.getsourcelines(obj)
+        except Exception:
+            lineno = None
+
+        if lineno:
+            linespec = "#L%d-L%d" % (lineno, lineno + len(source) - 1)
+        else:
+            linespec = ""
+
+        startdir = os.path.abspath(os.path.join(dirname(matplotlib.__file__), '..'))
+        fn = relpath(fn, start=startdir).replace(os.path.sep, '/')
+
+        if fn.startswith('matplotlib/'):
+            m = re.match(r'^.*post[0-9]+\+\w([a-z0-9]+).\w+$', matplotlib.__version__)
+            if m:
+                return "https://github.com/matplotlib/matplotlib/blob/%s/lib/%s%s" % (
+                        m.group(1), fn, linespec)
+            else:
+                return "https://github.com/matplotlib/matplotlib/blob/v%s/lib/%s%s" % (
+                        matplotlib.__version__, fn, linespec)
+        else:
+            return None
