add edit on github button to docs

ISISComputingGroup · Nov 28, 2024 · 39a618e · 39a618e
1 parent 59aa46a
commit 39a618e
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -29,6 +29,13 @@
 suppress_warnings =["docutils"]
 html_theme = "sphinx_rtd_theme"
 html_logo = "resources/logo/lewis-logo.png"
+html_context = {
+    "display_github": True,  # Integrate GitHub
+    "github_user": "ISISComputingGroup",  # Username
+    "github_repo": "lewis",  # Repo name
+    "github_version": "main",  # Version
+    "conf_py_path": "/doc/",  # Path in the checkout to the docs root
+}
 
 autoclass_content = "both"
 myst_heading_anchors = 3