Add overrides

docs/gen_ref_pages.py

@@ -63,8 +63,8 @@ def sub_index_text(module_name):
 
         if parts[-1] == "__init__":
             parts = parts[:-1]
-            doc_path = doc_path.with_name("index.md")
-            full_doc_path = full_doc_path.with_name("index.md")
+            #doc_path = doc_path.with_name("index.md")
+            #full_doc_path = full_doc_path.with_name("index.md")
         elif parts[-1] == "__main__":
             continue
 

docs/installation.md

@@ -1,5 +1,9 @@
 # Installation
 
+CAREamics is a deep-learning library and we therefore recommend having GPU support as
+training the algorithms on the CPU can be very slow. MacOS users can also benefit from
+GPU-acceleration if they have an M1 or M2 chip.
+
 1. We recommend using a virtual environment to install CAREamics.
 
     ```bash

docs/overrides/partials/content.html

@@ -0,0 +1,26 @@
+<!-- Tags -->
+{% if "material/tags" in config.plugins %}
+{% include "partials/tags.html" %}
+{% endif %}
+<!-- Actions -->
+{% include "partials/actions.html" %}
+<!--
+  Hack: check whether the content contains a h1 headline. If it doesn't, the
+  page title (or respectively site name) is used as the main headline.
+-->
+{% if "\x3ch1" not in page.content %}<h1>{{ page.title | d(config.site_name, true) }}</h1>{% endif %}
+<!-- Page content -->
+{{ page.content }}
+<!-- Source file information -->
+{% if page.meta and (
+page.meta.git_revision_date_localized or
+page.meta.revision_date
+) %}
+{% include "partials/source-file.html" %}
+{% endif %}
+<!-- Was this page helpful? -->
+{% include "partials/content_next.html" %}
+<!-- Was this page helpful? -->
+{% include "partials/feedback.html" %}
+<!-- Comment system -->
+{% include "partials/comments.html" %}

docs/overrides/partials/content_next.html

@@ -0,0 +1,40 @@
+<!-- Link to previous and/or next page -->
+{% if "navigation.content_next" in features %}
+{% if page.previous_page or page.next_page %}
+{% if page.meta and page.meta.hide %}
+{% set hidden = "hidden" if "footer" in page.meta.hide %}
+{% endif %}
+<nav class="md-footer__inner md-grid" aria-label="{{ lang.t('footer') }}" {{ hidden }}>
+    <!-- Link to previous page -->
+    {% if page.previous_page %}
+    {% set direction = lang.t("footer.previous") %}
+    <a href="{{ page.previous_page.url | url }}" class="md-footer__link md-footer__link--prev"
+        aria-label="{{ direction }}: {{ page.previous_page.title | e }}" rel="prev">
+        <div class="md-footer__button md-icon">{% include ".icons/material/arrow-left.svg" %}</div>
+        <kbd class="key-control prev">P</kbd>
+        <div class="md-footer__title">
+            <div class="md-ellipsis">
+                <span class="md-footer__direction">{{ direction }}</span>
+                {{ page.previous_page.title }}
+            </div>
+        </div>
+    </a>
+    {% endif %}
+    <!-- Link to next page -->
+    {% if page.next_page %}
+    {% set direction = lang.t("footer.next") %}
+    <a href="{{ page.next_page.url | url }}" class="md-footer__link md-footer__link--next"
+        aria-label="{{ direction }}: {{ page.next_page.title | e }}" rel="next">
+        <div class="md-footer__title">
+            <div class="md-ellipsis">
+                <span class="md-footer__direction">{{ direction }}</span>
+                {{ page.next_page.title }}
+            </div>
+        </div>
+        <kbd class="key-control">N</kbd>
+        <div class="md-footer__button md-icon">{% include ".icons/material/arrow-right.svg" %}</div>
+    </a>
+    {% endif %}
+</nav>
+{% endif %}
+{% endif %}