Merge branch 'main' into vale

Author: paddyroddy

.all-contributorsrc

@@ -300,6 +300,16 @@
         "a11y",
         "ideas"
       ]
+    },
+    {
+      "login": "cuteshaun",
+      "name": "Andrii Tsapko",
+      "avatar_url": "https://avatars.githubusercontent.com/u/28014041?v=4",
+      "profile": "https://github.com/cuteshaun",
+      "contributions": [
+        "a11y",
+        "code"
+      ]
     }
   ]
 }

.github/workflows/links.yml

@@ -35,6 +35,7 @@ jobs:
             --exclude http://www.gnu.org
             --exclude http://fsf.org
             --exclude docs/pages
+            --exclude docs/_includes
             --exclude-path '{{cookiecutter.project_slug}}/README.md'
             --exclude-path 'tests/data'
             -- ."

README.md

@@ -116,6 +116,7 @@ uv pip install -e ".[dev]"
       <td align="center" valign="top" width="14.28%"><a href="http://drandrewmitchell.com"><img src="https://avatars.githubusercontent.com/u/22335636?v=4?s=100" width="100px;" alt="Andrew Mitchell"/><br /><sub><b>Andrew Mitchell</b></sub></a><br /><a href="#bug-MitchellAcoustics" title="Bug reports">🐛</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://www.ucl.ac.uk/advanced-research-computing/advanced-research-computing-centre"><img src="https://avatars.githubusercontent.com/u/24316371?v=4?s=100" width="100px;" alt="Kimberly Meechan"/><br /><sub><b>Kimberly Meechan</b></sub></a><br /><a href="#bug-K-Meech" title="Bug reports">🐛</a> <a href="#a11y-K-Meech" title="Accessibility">️️️️♿️</a> <a href="#review-K-Meech" title="Reviewed Pull Requests">👀</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/jamesprime"><img src="https://avatars.githubusercontent.com/u/17751241?v=4?s=100" width="100px;" alt="James Prime"/><br /><sub><b>James Prime</b></sub></a><br /><a href="#a11y-jamesprime" title="Accessibility">️️️️♿️</a> <a href="#ideas-jamesprime" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/cuteshaun"><img src="https://avatars.githubusercontent.com/u/28014041?v=4?s=100" width="100px;" alt="Andrii Tsapko"/><br /><sub><b>Andrii Tsapko</b></sub></a><br /><a href="#a11y-cuteshaun" title="Accessibility">️️️️♿️</a> <a href="#code-cuteshaun" title="Code">💻</a></td>
     </tr>
   </tbody>
 </table>

docs/_config.yml

@@ -6,6 +6,8 @@ url: https://UCL-ARC.github.io/python-tooling
 
 color_scheme: dark
 
+layouts_dir: _layouts
+
 aux_links:
   Source repository: https://github.com/UCL-ARC/python-tooling
 aux_links_new_tab: true

docs/_includes/components/anchor_icon.html

@@ -0,0 +1,3 @@
+<svg viewBox="0 0 16 16" aria-hidden="true">
+  <use xlink:href="#svg-link"></use>
+</svg>

docs/_includes/header_custom.html

@@ -1,15 +1,19 @@
-<button class="btn js-toggle-dark-mode">☼</button>
+<button class="btn js-toggle-dark-mode" aria-label="Switch to light mode">
+  ☼
+</button>
 
 <script>
   const toggleDarkMode = document.querySelector(".js-toggle-dark-mode");
   jtd.addEvent(toggleDarkMode, "click", function () {
     if (jtd.getTheme() === "light") {
       jtd.setTheme("dark");
       toggleDarkMode.textContent = "☼";
+      toggleDarkMode.ariaLabel = "Switch to light mode";
       localStorage.setItem("theme", "dark");
     } else {
       jtd.setTheme("light");
       toggleDarkMode.textContent = "☾";
+      toggleDarkMode.ariaLabel = "Switch to dark mode";
       localStorage.setItem("theme", "light");
     }
   });

docs/_includes/sidebar.html

@@ -0,0 +1,25 @@
+{%- comment -%} Include as: {%- include components/sidebar.html -%} Depends on:
+page(?), site. Results in: HTML for the side bar. Includes: title.html,
+components/site_nav.html, nav_footer_custom.html Overwrites: nav_footer_custom.
+Should not be cached, because nav_footer_custom.html might depend on page. {%-
+endcomment -%}
+
+<div class="side-bar">
+  <div class="site-header" role="banner">
+    <a href="{{ '/' | relative_url }}" class="site-title lh-tight"
+      >{% include title.html %}</a
+    >
+    <button
+      id="menu-button"
+      class="site-button btn-reset"
+      aria-label="Toggle menu"
+      aria-pressed="false"
+    >
+      <svg viewBox="0 0 24 24" class="icon" aria-hidden="true">
+        <use xlink:href="#svg-menu"></use>
+      </svg>
+    </button>
+  </div>
+
+  {% include_cached components/site_nav.html %}
+</div>

docs/_layouts/default.html

@@ -0,0 +1,44 @@
+<!doctype html>
+<html lang="{{ site.lang | default: 'en-US' }}">
+  {% include head.html %}
+  <body>
+    <a class="skip-to-main" href="#main-content">Skip to main content</a>
+    {% include icons/icons.html %} {% if page.nav_enabled == true %} {% include
+    sidebar.html %} {% elsif layout.nav_enabled == true and page.nav_enabled ==
+    nil %} {% include sidebar.html %} {% elsif site.nav_enabled != false and
+    layout.nav_enabled == nil and page.nav_enabled == nil %} {% include
+    sidebar.html %} {% endif %}
+
+    <div class="main" id="top">
+      {% include components/header.html %}
+
+      <div class="main-content-wrap">
+        {% include components/breadcrumbs.html %}
+        <div id="main-content" class="main-content">
+          <main>
+            {% if site.heading_anchors != false %} {% capture raw_anchor_svg %}
+            {% include components/anchor_icon.html %} {% endcapture %} {% assign
+            anchor_svg = raw_anchor_svg | strip_newlines %} {% include
+            vendor/anchor_headings.html html=content beforeHeading="true"
+            anchorBody=anchor_svg anchorClass="anchor-heading"
+            anchorAttrs="aria-labelledby='%html_id%'" %} {% else %} {{ content
+            }} {% endif %} {% if page.has_toc != false %} {% include
+            components/children_nav.html %} {% endif %}
+          </main>
+        </div>
+      </div>
+
+      <footer class="site-footer">
+        This site uses
+        <a href="https://github.com/just-the-docs/just-the-docs"
+          >Just the Docs</a
+        >, a documentation theme for Jekyll.
+      </footer>
+
+      {% if site.search_enabled != false %} {% include
+      components/search_footer.html %} {% endif %}
+    </div>
+
+    {% if site.mermaid %} {% include components/mermaid.html %} {% endif %}
+  </body>
+</html>

docs/_sass/custom/custom.scss

@@ -1,3 +1,9 @@
+html,
+body {
+  height: 100%;
+  margin: 0;
+}
+
 div.site-header {
   max-height: 15em;
   height: 15em;
@@ -6,3 +12,19 @@ div.site-header {
 div.site-logo {
   background-position: center center;
 }
+
+.main {
+  display: flex;
+  flex-direction: column;
+  min-height: 100%;
+}
+
+.main-content-wrap {
+  flex: 1;
+}
+
+.site-footer {
+  position: static;
+  width: 100%;
+  color: $body-text-color;
+}