📚 Add GitHub repo link to docs sidebar

docs/conf.py

@@ -20,7 +20,7 @@
 ]
 
 exclude_patterns: list[str] = []
-templates_path: list[str] = []
+templates_path = ["source/_static/_templates/furo"]
 
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
@@ -40,6 +40,20 @@
     "source_branch": "main",
     "source_directory": "docs/source/",
 }
+html_sidebars = {
+    "**": [
+        "sidebar/brand.html",
+        "sidebar/search.html",
+        "sidebar/scroll-start.html",
+        "sidebar/navigation.html",
+        "sidebar/ethical-ads.html",
+        "sidebar/scroll-end.html",
+        "side-github.html",
+        "sidebar/variant-selector.html",
+    ]
+}
+html_context = {"repository": "useblocks/sphinx-mounts"}
+html_css_files = ["furo.css"]
 
 # Named hyperlink targets for sibling useblocks projects. Defined once
 # here (appended to every RST source via ``rst_epilog``) so the URLs are

docs/source/_static/_templates/furo/side-github.html

@@ -0,0 +1,37 @@
+<a
+  class="gh-source"
+  href="{{ theme_source_repository }}"
+  aria-label="On GitHub"
+  target="_blank"
+>
+  <svg
+    stroke="currentColor"
+    fill="currentColor"
+    stroke-width="0"
+    viewBox="0 0 16 16"
+    class="gh-source--icon"
+  >
+    <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>
+  <span class="gh-source--info">
+    <span class="gh-source--repo-text"> {{ repository }} </span>
+    <span class="gh-source--version">
+      <svg
+        stroke="currentColor"
+        fill="currentColor"
+        stroke-width="0"
+        viewBox="0 0 16 16"
+        class="gh-source--version-icon"
+      >
+        <path
+          fill-rule="evenodd"
+          d="M2.5 7.775V2.75a.25.25 0 0 1 .25-.25h5.025a.25.25 0 0 1 .177.073l6.25 6.25a.25.25 0 0 1 0 .354l-5.025 5.025a.25.25 0 0 1-.354 0l-6.25-6.25a.25.25 0 0 1-.073-.177zm-1.5 0V2.75C1 1.784 1.784 1 2.75 1h5.025c.464 0 .91.184 1.238.513l6.25 6.25a1.75 1.75 0 0 1 0 2.474l-5.026 5.026a1.75 1.75 0 0 1-2.474 0l-6.25-6.25A1.75 1.75 0 0 1 1 7.775zM6 5a1 1 0 1 0 0 2 1 1 0 0 0 0-2z"
+        />
+      </svg>
+      <span class="gh-source--version-text"> {{ version }} </span>
+    </span>
+  </span>
+</a>

docs/source/_static/furo.css

@@ -0,0 +1,45 @@
+/* Source-repo link in the left sidebar (rendered by side-github.html). */
+.gh-source {
+    display: flex;
+    align-items: center;
+    gap: .5em;
+    padding-left: var(--sidebar-item-spacing-horizontal);
+    padding-right: var(--sidebar-item-spacing-horizontal);
+    padding-top: .6em;
+    padding-bottom: .6em;
+    text-decoration: none;
+    border-top: 1px solid var(--color-background-border);
+    border-bottom: 1px solid var(--color-background-border);
+}
+
+.gh-source--icon {
+    height: 1.5em;
+    color: var(--color-foreground-primary);
+}
+
+.gh-source:hover .gh-source--info * {
+    color: var(--color-foreground-primary);
+}
+
+.gh-source--info {
+    display: inline-flex;
+    flex-direction: column;
+    gap: .1em;
+}
+
+.gh-source--version {
+    display: inline-flex;
+    align-items: center;
+    gap: .2em;
+}
+
+.gh-source--version-icon {
+    height: .8em;
+}
+
+.gh-source--version-icon,
+.gh-source--version-text,
+.gh-source--repo-text {
+    font-size: .8em;
+    color: var(--color-foreground-muted);
+}