Add custom prev-next option

Checks page for `prev_link`/`next_link` and `prev_title`/`next_title`
first, to allow for custom prev/next links. This also allow for custom
titles, which, while not yet utilized, can be useful in situations such
as shortening a long page title's link.

Enabled on two pages, to address issue with container only path leading
to an LmP content page, and for fioctl to point back to getting started, rather
than an LmP content page.

Checked running a local server instance for correct rendering and links.

This commit applies to issue FFTK-4720, "…Getting Started flow…"
This commit applies to issue FFTK-4681, "…Customizable prev/next…"

Signed-off-by: Katrina Prosise <katrina.prosise@foundries.io>

Author: kprosise

source/_templates/prev-next.html

@@ -1,13 +1,26 @@
-{%- if (show_prev_next == 'true') and (next or prev) %}
-  {#- Translators: This is an ARIA section label for the footer section of the page. -#}
-  <div class="rst-footer-buttons" role="navigation" aria-label="{{ _('Footer') }}">
-    {%- if prev %}
-      <a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p" rel="prev" data-analytics-event="cta" data-analytics-action="click" data-analytics-label="previous" data-analytics-detail="{{ prev.title|striptags|e }}" data-analytics-location="{{ prev.link|e }}"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> {{ _('Previous') }}</a>
-    {%- endif %}
-    {%- if next %}
-      <a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n" rel="next" data-analytics-event="cta" data-analytics-action="click" data-analytics-label="next" data-analytics-detail="{{ next.title|striptags|e }}" data-analytics-location="{{ next.link|e }}">{{ _('Next') }} <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
-    {%- endif %}
-  </div>
-{%- endif %}
-
-<hr/>
+{# Modified version of PyData's prev-next, checks page metadata for custom links first #}
+{# Displays links to the previous and next page in the TOCtree order. #}
+<div class="prev-next-area">
+  {%- if prev %}
+    <a class="left-prev"
+       href="{{ meta.prev_link or prev.link|e }}"
+       title="{{ _('previous page') }}">
+      <i class="fa-solid fa-angle-left"></i>
+      <div class="prev-next-info">
+        <p class="prev-next-subtitle">{{ _("previous") }}</p>
+        <p class="prev-next-title">{{ meta.prev_title or prev.title }}</p>
+      </div>
+    </a>
+  {%- endif %}
+  {%- if next %}
+    <a class="right-next"
+       href="{{ meta.next_link or next.link|e }}"
+       title="{{ _('next page') }}">
+      <div class="prev-next-info">
+        <p class="prev-next-subtitle">{{ _("next") }}</p>
+        <p class="prev-next-title">{{ meta.next_title or next.title }}</p>
+      </div>
+      <i class="fa-solid fa-angle-right"></i>
+    </a>
+  {%- endif %}
+</div>

source/conf.py

@@ -276,6 +276,7 @@
     'navbar_persistent': [],
     'navbar_end': ['version-switcher', 'theme-switcher', 'navbar-icon-links'],
     'secondary_sidebar_items': ['page-toc', 'book-demo'],
+    'show_prev_next': False, # turn off default theme
     'article_footer_items': ['prev-next'],
     'content_footer_items': [],
     'footer_start':['copyright'],

source/getting-started/fioup-registration/index.rst

@@ -1,3 +1,7 @@
+:next_link: ../install-fioctl/index.html
+
+:next_title: Installing Fioctl
+
 Registering Your Device with Fioup
 ==================================
 

source/getting-started/install-fioctl/index.rst

@@ -1,3 +1,7 @@
+:prev_link: ../index.html
+
+:prev_title: Getting Started
+
 .. _gs-install-fioctl:
 
 Installing Fioctl