docs: update theme to current starter pack theme

docs/.sphinx/_static/custom.css

@@ -26,9 +26,9 @@ table.docutils td, table.docutils th, table.docutils td:last-child, table.docuti
  border-left: none;
 }
 
-/* center align table cells with ":-:" */
-td.text-center {
- text-align: center;
+/* Allow to centre text horizontally in table data cells */
+table.align-center {
+ text-align: center !important;
 }
 
 /** No rounded corners **/
@@ -168,3 +168,22 @@ ol.arabic ol.arabic {
 details summary {
  color: var(--color-link);
 }
+
+/** Fix the styling of the version box for readthedocs **/
+
+#furo-readthedocs-versions .rst-versions, #furo-readthedocs-versions .rst-current-version, #furo-readthedocs-versions:focus-within .rst-current-version, #furo-readthedocs-versions:hover .rst-current-version {
+ background: var(--color-sidebar-item-background--hover);
+}
+
+.rst-versions .rst-other-versions dd a {
+ color: var(--color-link);
+}
+
+#furo-readthedocs-versions:focus-within .rst-current-version .fa-book, #furo-readthedocs-versions:hover .rst-current-version .fa-book, .rst-versions .rst-other-versions {
+ color: var(--color-sidebar-link-text);
+}
+
+.rst-versions .rst-current-version {
+ color: var(--color-version-popup);
+ font-weight: bolder;
+}

docs/.sphinx/_static/github_issue_links.css

@@ -0,0 +1,24 @@
+.github-issue-link-container {
+ padding-right: 0.5rem;
+}
+.github-issue-link {
+ font-size: var(--font-size--small);
+ font-weight: bold;
+ background-color: #DD4814;
+ padding: 13px 23px;
+ text-decoration: none;
+}
+.github-issue-link:link {
+ color: #FFFFFF;
+}
+.github-issue-link:visited {
+ color: #FFFFFF
+}
+.muted-link.github-issue-link:hover {
+ color: #FFFFFF;
+ text-decoration: underline;
+}
+.github-issue-link:active {
+ color: #FFFFFF;
+ text-decoration: underline;
+}

docs/.sphinx/_static/github_issue_links.js

@@ -0,0 +1,26 @@
+window.onload = function() {
+ const link = document.createElement("a");
+ link.classList.add("muted-link");
+ link.classList.add("github-issue-link");
+ link.text = "Give feedback";
+ link.href = (
+ github_url
+ + "/issues/new?"
+ + "title=docs%3A+TYPE+YOUR+QUESTION+HERE"
+ + "&body=*Please describe the question or issue you're facing with "
+ + `"${document.title}"`
+ + ".*"
+ + "%0A%0A%0A%0A%0A"
+ + "---"
+ + "%0A"
+ + `*Reported+from%3A+${location.href}*`
+ );
+ link.target = "_blank";
+
+ const div = document.createElement("div");
+ div.classList.add("github-issue-link-container");
+ div.append(link)
+
+ const container = document.querySelector(".article-container > .content-icon-container");
+ container.prepend(div);
+};

docs/.sphinx/_templates/base.html

@@ -0,0 +1,7 @@
+{% extends "furo/base.html" %}
+
+{% block theme_scripts %}
+<script>
+ const github_url = "{{ github_url }}";
+</script>
+{% endblock theme_scripts %}

docs/.sphinx/_templates/footer.html

@@ -0,0 +1,90 @@
+{# ru-fu: copied from Furo, with modifications as stated below #}
+
+<div class="related-pages">
+ {% if next -%}
+ <a class="next-page" href="{{ next.link }}">
+ <div class="page-info">
+ <div class="context">
+ <span>{{ _("Next") }}</span>
+ </div>
+ <div class="title">{{ next.title }}</div>
+ </div>
+ <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
+ </a>
+ {%- endif %}
+ {% if prev -%}
+ <a class="prev-page" href="{{ prev.link }}">
+ <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
+ <div class="page-info">
+ <div class="context">
+ <span>{{ _("Previous") }}</span>
+ </div>
+ {% if prev.link == pathto(master_doc) %}
+ <div class="title">{{ _("Home") }}</div>
+ {% else %}
+ <div class="title">{{ prev.title }}</div>
+ {% endif %}
+ </div>
+ </a>
+ {%- endif %}
+</div>
+<div class="bottom-of-page">
+ <div class="left-details">
+ {%- if show_copyright %}
+ <div class="copyright">
+ {%- if hasdoc('copyright') %}
+ {% trans path=pathto('copyright'), copyright=copyright|e -%}
+ <a href="{{ path }}">Copyright</a> &#169; {{ copyright }}
+ {%- endtrans %}
+ {%- else %}
+ {% trans copyright=copyright|e -%}
+ Copyright &#169; {{ copyright }}
+ {%- endtrans %}
+ {%- endif %}
+ </div>
+ {%- endif %}
+
+ {# ru-fu: removed "Made with" #}
+
+ {%- if last_updated -%}
+ <div class="last-updated">
+ {% trans last_updated=last_updated|e -%}
+ Last updated on {{ last_updated }}
+ {%- endtrans -%}
+ </div>
+ {%- endif %}
+
+ {%- if show_source and has_source and sourcename %}
+ <div class="show-source">
+ <a class="muted-link" href="{{ pathto('_sources/' + sourcename, true)|e }}"
+ rel="nofollow">Show source</a>
+ </div>
+ {%- endif %}
+ </div>
+ <div class="right-details">
+
+ {# ru-fu: replaced RTD icons with our links #}
+
+ {% if discourse %}
+ <div class="ask-discourse">
+ <a class="muted-link" href="{{ discourse }}">Ask a question on Discourse</a>
+ </div>
+ {% endif %}
+
+ {% if github_url and github_version and github_folder %}
+
+ {% if github_issues %}
+ <div class="issue-github">
+ <a class="muted-link" href="{{ github_url }}/issues/new?title=doc%3A+ADD+A+TITLE&body=DESCRIBE+THE+ISSUE%0A%0A---%0ADocument: {{ pagename }}{{ page_source_suffix }}">Open a GitHub issue for this page</a>
+ </div>
+ {% endif %}
+
+ <div class="edit-github">
+ <a class="muted-link" href="{{ github_url }}/edit/{{ github_version }}{{ github_folder }}{{ pagename }}{{ page_source_suffix }}">Edit this page on GitHub</a>
+ </div>
+ {% endif %}
+
+
+ </div>
+ </div>
+</div>

docs/.sphinx/_templates/page.html

@@ -0,0 +1,44 @@
+{% extends "furo/page.html" %}
+
+{% block footer %}
+ {% include "footer.html" %}
+{% endblock footer %}
+
+{% if meta and ((meta.discourse and discourse_prefix) or meta.relatedlinks) %}
+ {% set furo_hide_toc_orig = furo_hide_toc %}
+ {% set furo_hide_toc=false %}
+{% endif %}
+
+{% block right_sidebar %}
+<div class="toc-sticky toc-scroll">
+ {% if not furo_hide_toc_orig %}
+ <div class="toc-title-container">
+ <span class="toc-title">
+ {{ _("Contents") }}
+ </span>
+ </div>
+ <div class="toc-tree-container">
+ <div class="toc-tree">
+ {{ toc }}
+ </div>
+ </div>
+ {% endif %}
+ {% if meta and ((meta.discourse and discourse_prefix) or meta.relatedlinks) %}
+ <div class="relatedlinks-title-container">
+ <span class="relatedlinks-title">
+ Related links
+ </span>
+ </div>
+ <div class="relatedlinks-container">
+ <div class="relatedlinks">
+ {% if meta.discourse and discourse_prefix %}
+ {{ discourse_links(meta.discourse) }}
+ {% endif %}
+ {% if meta.relatedlinks %}
+ {{ related_links(meta.relatedlinks) }}
+ {% endif %}
+ </div>
+ </div>
+ {% endif %}
+ </div>
+{% endblock right_sidebar %}

docs/.sphinx/pinned-requirements.txt

@@ -1,34 +1,57 @@
-alabaster==0.7.12
-Babel==2.11.0
-beautifulsoup4==4.11.1
+alabaster==0.7.13
+Babel==2.12.1
+beautifulsoup4==4.11.2
+bracex==2.3.post1
 certifi==2022.12.7
-charset-normalizer==2.1.1
+charset-normalizer==3.1.0
 colorama==0.4.6
+contourpy==1.0.7
+cycler==0.11.0
 docutils==0.19
-furo==2022.9.29
+fonttools==4.39.0
+furo==2022.12.7
+html5lib==1.1
 idna==3.4
 imagesize==1.4.1
+importlib-metadata==6.0.0
+importlib-resources==5.12.0
 Jinja2==3.1.2
+kiwisolver==1.4.4
 livereload==2.6.3
-MarkupSafe==2.1.1
-packaging==21.3
-pyenchant==3.2.2
-Pygments==2.13.0
+lxd-sphinx-extensions==0.0.6
+lxml==4.9.2
+Markdown==3.4.1
+MarkupSafe==2.1.2
+matplotlib==3.7.1
+numpy==1.24.2
+packaging==23.0
+Pillow==9.4.0
+Pygments==2.14.0
 pyparsing==3.0.9
-pytz==2022.6
-requests==2.31.0
+pyspelling==2.8.2
+python-dateutil==2.8.2
+pytz==2022.7.1
+PyYAML==6.0
+requests==2.28.2
 six==1.16.0
 snowballstemmer==2.2.0
-soupsieve==2.3.2.post1
-Sphinx==5.3.0
+soupsieve==2.4
+sphinx==6.1.3
 sphinx-autobuild==2021.3.14
 sphinx-basic-ng==1.0.0b1
-sphinx_design==0.3.0
-sphinxcontrib-applehelp==1.0.2
+sphinx-copybutton==0.5.1
+sphinx-design==0.3.0
+sphinx-reredirects==0.1.1
+sphinx-tabs==3.4.1
+sphinxcontrib-applehelp==1.0.4
 sphinxcontrib-devhelp==1.0.2
-sphinxcontrib-htmlhelp==2.0.0
+sphinxcontrib-htmlhelp==2.0.1
 sphinxcontrib-jsmath==1.0.1
 sphinxcontrib-qthelp==1.0.3
 sphinxcontrib-serializinghtml==1.1.5
-tornado==6.3.2
-urllib3==1.26.13
+sphinxext-opengraph==0.8.1
+tornado==6.2
+urllib3==1.26.14
+wcmatch==8.4.1
+webencodings==0.5.1
+zipp==3.15.0

docs/.sphinx/requirements.txt

@@ -6,6 +6,9 @@ furo
 sphinx-tabs
 sphinx-reredirects
 pyspelling
+sphinxext-opengraph
+lxd-sphinx-extensions
 sphinx-copybutton
 sphinx-pydantic
 sphinx-toolbox
+myst-parser

docs/.sphinx/spellingcheck.yaml

@@ -22,3 +22,5 @@ matrix:
  - link
  - title
  - div.relatedlinks
+ - div.visually-hidden
+ - img