docs: link back to source (#455)

* docs: link back to source Signed-off-by: Henry Schreiner <[email protected]> * style: pre-commit fixes --------- Signed-off-by: Henry Schreiner <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
scientific-python · Aug 5, 2024 · 2f1d453 · 2f1d453
1 parent 6c40f22
commit 2f1d453
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 0 deletions.
diff --git a/docs/pages/guides/docs.md b/docs/pages/guides/docs.md
@@ -82,6 +82,7 @@ with code_fence("python"):
 from __future__ import annotations
 
 import importlib.metadata
+from typing import Any
 
 project = "package"
 copyright = "2024, My Name"
@@ -110,6 +111,24 @@ exclude_patterns = [
 
 html_theme = "furo"
 
+html_theme_options: dict[str, Any] = {
+    "footer_icons": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/org/package",
+            "html": """
+                <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
+                    <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
+                </svg>
+            """,
+            "class": "",
+        },
+    ],
+    "source_repository": "https://github.com/org/package",
+    "source_branch": "main",
+    "source_directory": "docs/",
+}
+
 myst_enable_extensions = [
     "colon_fence",
 ]

diff --git a/{{cookiecutter.project_name}}/docs/conf.py b/{{cookiecutter.project_name}}/docs/conf.py
@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import importlib.metadata
+from typing import Any
 
 project = "{{ cookiecutter.project_name }}"
 copyright = "{{ cookiecutter.__year }}, {{ cookiecutter.full_name }}"
@@ -29,6 +30,26 @@
 
 html_theme = "furo"
 
+html_theme_options: dict[str, Any] = {
+    {%- if cookiecutter.__ci == "github" %}
+    "footer_icons": [
+        {
+            "name": "GitHub",
+            "url": "{{ cookiecutter.url }}",
+            "html": """
+                <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
+                    <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
+                </svg>
+            """,
+            "class": "",
+        },
+    ],
+    {%- endif %}
+    "source_repository": "{{ cookiecutter.url }}",
+    "source_branch": "main",
+    "source_directory": "docs/",
+}
+
 myst_enable_extensions = [
     "colon_fence",
 ]