Include show source button, inherited members in API reference (#25)

Author: anna-follestad-4ss

.github/workflows/deploy_public.yml

@@ -43,7 +43,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install build sphinx pydata_sphinx_theme
+          python -m pip install build sphinx==5.3.0 pydata_sphinx_theme==0.11.0
 
       - name: Get new version number from input
         id: version_number

build_doc.bat

@@ -1,2 +1,2 @@
-sphinx-build -b html ./docs ./build/html
+sphinx-build -b html ./docs ./build/html -E
 pause

docs/conf.py

@@ -6,6 +6,8 @@
 
 # -- Path setup --------------------------------------------------------------
 
+import inspect
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -24,6 +26,7 @@
 project = "fourinsight-api"
 copyright = f"{date.today().year}, 4Subsea"
 author = "4Subsea"
+github_repo = "https://github.com/4Subsea/fourinsight-api-python/"
 
 # The full version, including alpha/beta/rc tags
 version = metadata.version(project)
@@ -40,7 +43,33 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",
     "sphinx.ext.intersphinx",
+    "sphinx.ext.linkcode",
 ]
+
+
+def linkcode_resolve(domain, info):
+    if domain != "py":
+        return None
+    if not info["module"]:
+        return None
+
+    obj = sys.modules[info["module"]]
+
+    for part in info["fullname"].split("."):
+        obj = getattr(obj, part)
+    obj = inspect.unwrap(obj)
+
+    try:
+        path = os.path.relpath(inspect.getfile(obj))
+        src, lineno = inspect.getsourcelines(obj)
+
+        path = f"{github_repo}blob/main/{path}#L{lineno}-L{lineno + len(src) - 1}"
+
+    except Exception:
+        path = None
+    return path
+
+
 autosummary_generate = True
 
 # Napoleon settings
@@ -86,7 +115,7 @@
     "icon_links": [
         {
             "name": "GitHub",
-            "url": "https://github.com/4Subsea/fourinsight-api-python",
+            "url": github_repo,
             "icon": "fab fa-github",
         },
         {

tox-deploy.ini

@@ -5,8 +5,8 @@ envlist = py39
 [testenv]
 deps =
     build
-    sphinx
-    pydata_sphinx_theme
+    sphinx==5.3.0
+    pydata_sphinx_theme==0.11.0
 commands =
     python -m build --outdir ./build
     sphinx-build -b html ./docs ./build/html

tox.ini

@@ -15,6 +15,6 @@ deps =
 basepython = python3.9
 changedir = docs
 deps =
-    sphinx
-    pydata_sphinx_theme
+    sphinx==5.3.0
+    pydata_sphinx_theme==0.11.0
 commands = sphinx-build -W -b html -d {envtmpdir}/doctrees . {envtmpdir}/html