docs: "Edit on GitHub" button (#1831)

ApeWorX · Jan 8, 2024 · 481cc83 · 481cc83
1 parent 1a329b9
commit 481cc83
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html
@@ -255,5 +255,11 @@
 
   {%- block footer %} {% endblock %}
 
+  {% if display_github %}
+      <li><a href="https://github.com/{{ github_user }}/{{ github_repo }}
+      /blob/{{ github_version }}/{{ conf_py_path }}{{ pagename }}.rst">
+      Show on GitHub</a></li>
+  {% endif %}
+
 </body>
 </html>
diff --git a/docs/conf.py b/docs/conf.py
@@ -120,4 +120,9 @@ def setup(app):
 html_context = {
     "fixpath": fixpath,
     "get_versions": get_versions,
+    "display_github": True,
+    "github_user": "ApeWorX",
+    "github_repo": "ape",
+    "github_version": "main",
+    "conf_py_path": "/docs/",
 }