deploy: 546c466

PandABlocks · Oct 4, 2024 · 1799e17 · 1799e17
1 parent cc5f394
commit 1799e17
Show file tree

Hide file tree

Showing 19 changed files with 39 additions and 34 deletions.
diff --git a/docs_and_docker/.buildinfo b/docs_and_docker/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: f97264e9eaf25c5de23f3417c7165267
+config: 57759d66327bd7246369b0bc4f00e2e0
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs_and_docker/.doctrees/how-to/building.doctree b/docs_and_docker/.doctrees/how-to/building.doctree
diff --git a/docs_and_docker/.doctrees/how-to/quickstart.doctree b/docs_and_docker/.doctrees/how-to/quickstart.doctree
diff --git a/docs_and_docker/.doctrees/how-to/remote.doctree b/docs_and_docker/.doctrees/how-to/remote.doctree
diff --git a/docs_and_docker/.doctrees/index.doctree b/docs_and_docker/.doctrees/index.doctree
diff --git a/docs_and_docker/_sources/how-to/remote.rst.txt b/docs_and_docker/_sources/how-to/remote.rst.txt
@@ -4,7 +4,7 @@ Updating a PandA via SSH
 ========================
 
 The Admin interface of the PandA can be used to update the firmware as detailed
-in the quickstart_doc_, but sometimes it is necessary to update a number of
+in the _web_doc, but sometimes it is necessary to update a number of
 PandAs at once. The SSH interface can be used to do this.
 
 To gain access over SSH, either add an ``authorized_keys`` file to the SD card,
@@ -21,8 +21,6 @@ It is then possible to log in remotely and perform operations on the PandA.
 First update rootfs and then, after a reboot, update to the latest available zpkg 
 packages (while making sure to match the major versions of everything).
 
-.. _quickstart_doc: https://pandablocks.github.io/PandABlocks-rootfs/master/quickstart.html
-
 Updating the rootfs
 -------------------
 

diff --git a/docs_and_docker/_sphinx_design_static/sphinx-design.min.css b/docs_and_docker/_sphinx_design_static/sphinx-design.min.css
diff --git a/docs_and_docker/_static/documentation_options.js b/docs_and_docker/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '3.1a6.dev1+g7ceea86',
+    VERSION: '3.1b2.dev17+g546c466',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs_and_docker/_static/searchtools.js b/docs_and_docker/_static/searchtools.js
@@ -178,7 +178,7 @@ const Search = {
 
   htmlToText: (htmlString, anchor) => {
     const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
-    for (const removalQuery of [".headerlinks", "script", "style"]) {
+    for (const removalQuery of [".headerlink", "script", "style"]) {
       htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
     }
     if (anchor) {
@@ -328,13 +328,14 @@ const Search = {
     for (const [title, foundTitles] of Object.entries(allTitles)) {
       if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) {
         for (const [file, id] of foundTitles) {
-          let score = Math.round(100 * queryLower.length / title.length)
+          const score = Math.round(Scorer.title * queryLower.length / title.length);
+          const boost = titles[file] === title ? 1 : 0;  // add a boost for document titles
           normalResults.push([
             docNames[file],
             titles[file] !== title ? `${titles[file]} > ${title}` : title,
             id !== null ? "#" + id : "",
             null,
-            score,
+            score + boost,
             filenames[file],
           ]);
         }

diff --git a/docs_and_docker/_static/sphinx-design.min.css b/docs_and_docker/_static/sphinx-design.min.css
diff --git a/docs_and_docker/genindex.html b/docs_and_docker/genindex.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; PandABlocks-rootfs 3.1a6.dev1+g7ceea86 documentation</title>
+    <title>Index &#8212; PandABlocks-rootfs 3.1b2.dev17+g546c466 documentation</title>
 
 
 
@@ -30,15 +30,15 @@
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=fd3f3429" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
-    <link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=87e54e7c" />
+    <link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />
     <link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=4a1c6285" />
 
   <!-- Pre-loaded scripts that we'll load fully later -->
   <link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b" />
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="_static/documentation_options.js?v=cc7c620c"></script>
+    <script src="_static/documentation_options.js?v=33b69804"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/docs_and_docker/how-to/building.html b/docs_and_docker/how-to/building.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Building the Root File System &#8212; PandABlocks-rootfs 3.1a6.dev1+g7ceea86 documentation</title>
+    <title>Building the Root File System &#8212; PandABlocks-rootfs 3.1b2.dev17+g546c466 documentation</title>
 
 
 
@@ -31,15 +31,15 @@
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=fd3f3429" />
     <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
-    <link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=87e54e7c" />
+    <link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=95c83b7e" />
     <link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=4a1c6285" />
 
   <!-- Pre-loaded scripts that we'll load fully later -->
   <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b" />
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../_static/documentation_options.js?v=cc7c620c"></script>
+    <script src="../_static/documentation_options.js?v=33b69804"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/docs_and_docker/how-to/quickstart.html b/docs_and_docker/how-to/quickstart.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Getting a PandA on the network &#8212; PandABlocks-rootfs 3.1a6.dev1+g7ceea86 documentation</title>
+    <title>Getting a PandA on the network &#8212; PandABlocks-rootfs 3.1b2.dev17+g546c466 documentation</title>
 
 
 
@@ -31,15 +31,15 @@
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=fd3f3429" />
     <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
-    <link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=87e54e7c" />
+    <link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=95c83b7e" />
     <link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=4a1c6285" />
 
   <!-- Pre-loaded scripts that we'll load fully later -->
   <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b" />
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../_static/documentation_options.js?v=cc7c620c"></script>
+    <script src="../_static/documentation_options.js?v=33b69804"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/docs_and_docker/how-to/remote.html b/docs_and_docker/how-to/remote.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Updating a PandA via SSH &#8212; PandABlocks-rootfs 3.1a6.dev1+g7ceea86 documentation</title>
+    <title>Updating a PandA via SSH &#8212; PandABlocks-rootfs 3.1b2.dev17+g546c466 documentation</title>
 
 
 
@@ -31,15 +31,15 @@
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=fd3f3429" />
     <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
-    <link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=87e54e7c" />
+    <link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=95c83b7e" />
     <link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=4a1c6285" />
 
   <!-- Pre-loaded scripts that we'll load fully later -->
   <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b" />
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../_static/documentation_options.js?v=cc7c620c"></script>
+    <script src="../_static/documentation_options.js?v=33b69804"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -460,7 +460,7 @@
   <section id="updating-a-panda-via-ssh">
 <span id="ssh-doc"></span><h1>Updating a PandA via SSH<a class="headerlink" href="#updating-a-panda-via-ssh" title="Link to this heading">#</a></h1>
 <p>The Admin interface of the PandA can be used to update the firmware as detailed
-in the <a class="reference external" href="https://pandablocks.github.io/PandABlocks-rootfs/master/quickstart.html">quickstart_doc</a>, but sometimes it is necessary to update a number of
+in the _web_doc, but sometimes it is necessary to update a number of
 PandAs at once. The SSH interface can be used to do this.</p>
 <p>To gain access over SSH, either add an <code class="docutils literal notranslate"><span class="pre">authorized_keys</span></code> file to the SD card,
 or load it from USB via the Admin interface.</p>

diff --git a/docs_and_docker/index.html b/docs_and_docker/index.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>PandABlocks-rootfs &#8212; PandABlocks-rootfs 3.1a6.dev1+g7ceea86 documentation</title>
+    <title>PandABlocks-rootfs &#8212; PandABlocks-rootfs 3.1b2.dev17+g546c466 documentation</title>
 
 
 
@@ -31,15 +31,15 @@
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=fd3f3429" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
-    <link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=87e54e7c" />
+    <link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />
     <link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=4a1c6285" />
 
   <!-- Pre-loaded scripts that we'll load fully later -->
   <link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b" />
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="_static/documentation_options.js?v=cc7c620c"></script>
+    <script src="_static/documentation_options.js?v=33b69804"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/docs_and_docker/search.html b/docs_and_docker/search.html
@@ -6,7 +6,7 @@
 
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><title>Search - PandABlocks-rootfs 3.1a6.dev1+g7ceea86 documentation</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><title>Search - PandABlocks-rootfs 3.1b2.dev17+g546c466 documentation</title>
 
 
 
@@ -29,15 +29,15 @@
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=fd3f3429" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
-    <link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=87e54e7c" />
+    <link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />
     <link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=4a1c6285" />
 
   <!-- Pre-loaded scripts that we'll load fully later -->
   <link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b" />
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="_static/documentation_options.js?v=cc7c620c"></script>
+    <script src="_static/documentation_options.js?v=33b69804"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/clipboard.min.js?v=a7894cd8"></script>