deploy: b29bca1

PandABlocks · Mar 22, 2024 · 8836f3a · 8836f3a
1 parent d79d9c5
commit 8836f3a
Show file tree

Hide file tree

Showing 30 changed files with 367 additions and 131 deletions.
diff --git a/doc_changes/.buildinfo b/doc_changes/.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: 76afb948192370dba02f05932040d05f
+config: 776f0dc0f4e8b1b44ad04609776e6086
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/doc_changes/.doctrees/environment.pickle b/doc_changes/.doctrees/environment.pickle
diff --git a/doc_changes/.doctrees/index.doctree b/doc_changes/.doctrees/index.doctree
diff --git a/doc_changes/_downloads/5bef59fe249d5283a14772fe8c2e7605/tutorial2_position_capture-1.pdf b/doc_changes/_downloads/5bef59fe249d5283a14772fe8c2e7605/tutorial2_position_capture-1.pdf
diff --git a/doc_changes/_downloads/b1044b53fd298f2e9771da4a700c37f2/tutorial2_position_capture-2.pdf b/doc_changes/_downloads/b1044b53fd298f2e9771da4a700c37f2/tutorial2_position_capture-2.pdf
diff --git a/doc_changes/_sources/index.rst.txt b/doc_changes/_sources/index.rst.txt
@@ -9,6 +9,7 @@ How the documentation is structured
 The documentation is split into 2 sections:
 
 .. grid:: 2
+    :gutter: 4
 
     .. grid-item-card:: :material-regular:`person;4em`
         :link: user/index
@@ -27,6 +28,10 @@ The documentation is split into 2 sections:
         .. toctree::
             :caption: Explanations
             :maxdepth: 1
+
+	    developer/explanations/decisions
+
+	Explanations of how and why the architecture is why it is.
 
 The Existing Documentation for the PandABlocks projects can be found:
 

diff --git a/doc_changes/_static/documentation_options.js b/doc_changes/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '3.1.dev11+g4b45523',
+    VERSION: '3.1.dev12+gb29bca1',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/doc_changes/developer/explanations/decisions.html b/doc_changes/developer/explanations/decisions.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>Architectural Decision Records &#8212; PandABlocks.github.io 3.1.dev11+g4b45523 documentation</title>
+    <title>Architectural Decision Records &#8212; PandABlocks.github.io 3.1.dev12+gb29bca1 documentation</title>
 
 
 
@@ -39,7 +39,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
   <script src="../../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>
 
-    <script src="../../_static/documentation_options.js?v=1e4f3aee"></script>
+    <script src="../../_static/documentation_options.js?v=f0560c2c"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -56,7 +56,7 @@
     <link rel="index" title="Index" href="../../genindex.html" />
     <link rel="search" title="Search" href="../../search.html" />
     <link rel="next" title="1. Record architecture decisions" href="decisions/0001-record-architecture-decisions.html" />
-    <link rel="prev" title="Run in a container" href="../how-to/run-container.html" />
+    <link rel="prev" title="PandABlocks.github.io" href="../../index.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
   </head>
@@ -149,14 +149,21 @@
 <nav class="navbar-nav">
   <ul class="bd-navbar-elements navbar-nav">
 
+                    <li class="nav-item current active">
+                      <a class="nav-link nav-internal" href="#">
+                        Architectural Decision Records
+                      </a>
+                    </li>
+
+
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="../../user/index.html">
                         User Guide
                       </a>
                     </li>
 
 
-                    <li class="nav-item current active">
+                    <li class="nav-item">
                       <a class="nav-link nav-internal" href="../index.html">
                         Developer Guide
                       </a>
@@ -303,14 +310,21 @@
 <nav class="navbar-nav">
   <ul class="bd-navbar-elements navbar-nav">
 
+                    <li class="nav-item current active">
+                      <a class="nav-link nav-internal" href="#">
+                        Architectural Decision Records
+                      </a>
+                    </li>
+
+
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="../../user/index.html">
                         User Guide
                       </a>
                     </li>
 
 
-                    <li class="nav-item current active">
+                    <li class="nav-item">
                       <a class="nav-link nav-internal" href="../index.html">
                         Developer Guide
                       </a>
@@ -405,24 +419,9 @@
 <nav class="bd-docs-nav bd-links"
      aria-label="Section Navigation">
   <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
-  <div class="bd-toc-item navbar-nav"><p aria-level="2" class="caption" role="heading"><span class="caption-text">How-to Guides</span></p>
-<ul class="nav bd-sidenav">
-<li class="toctree-l1"><a class="reference internal" href="../how-to/contribute.html">Contributing to the project</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../how-to/update-tools.html">Update the tools</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../how-to/make-release.html">Make a release</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../how-to/run-container.html">Run in a container</a></li>
-</ul>
-<p aria-level="2" class="caption" role="heading"><span class="caption-text">Explanations</span></p>
-<ul class="current nav bd-sidenav">
-<li class="toctree-l1 current active has-children"><a class="current reference internal" href="#">Architectural Decision Records</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
-<li class="toctree-l2"><a class="reference internal" href="decisions/0001-record-architecture-decisions.html">1. Record architecture decisions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="decisions/0002-switched-to-pip-skeleton.html">2. Adopt python3-pip-skeleton for project structure</a></li>
-</ul>
-</li>
-</ul>
-<p aria-level="2" class="caption" role="heading"><span class="caption-text">Reference</span></p>
-<ul class="nav bd-sidenav">
-<li class="toctree-l1"><a class="reference internal" href="../reference/standards.html">Standards</a></li>
+  <div class="bd-toc-item navbar-nav"><ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="decisions/0001-record-architecture-decisions.html">1. Record architecture decisions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="decisions/0002-switched-to-pip-skeleton.html">2. Adopt python3-pip-skeleton for project structure</a></li>
 </ul>
 </div>
 </nav></div>
@@ -460,9 +459,6 @@
         <i class="fa-solid fa-home"></i>
       </a>
     </li>
-
-    <li class="breadcrumb-item"><a href="../index.html" class="nav-link">Developer Guide</a></li>
-
     <li class="breadcrumb-item active" aria-current="page">Architectura...</li>
   </ul>
 </nav>
@@ -504,12 +500,12 @@ <h1>Architectural Decision Records<a class="headerlink" href="#architectural-dec
 
 <div class="prev-next-area">
     <a class="left-prev"
-       href="../how-to/run-container.html"
+       href="../../index.html"
        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">Run in a container</p>
+        <p class="prev-next-title">PandABlocks.github.io</p>
       </div>
     </a>
     <a class="right-next"

diff --git a/doc_changes/developer/explanations/decisions/0001-record-architecture-decisions.html b/doc_changes/developer/explanations/decisions/0001-record-architecture-decisions.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>1. Record architecture decisions &#8212; PandABlocks.github.io 3.1.dev11+g4b45523 documentation</title>
+    <title>1. Record architecture decisions &#8212; PandABlocks.github.io 3.1.dev12+gb29bca1 documentation</title>
 
 
 
@@ -39,7 +39,7 @@
 <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
   <script src="../../../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>
 
-    <script src="../../../_static/documentation_options.js?v=1e4f3aee"></script>
+    <script src="../../../_static/documentation_options.js?v=f0560c2c"></script>
     <script src="../../../_static/doctools.js?v=888ff710"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -149,14 +149,21 @@
 <nav class="navbar-nav">
   <ul class="bd-navbar-elements navbar-nav">
 
+                    <li class="nav-item current active">
+                      <a class="nav-link nav-internal" href="../decisions.html">
+                        Architectural Decision Records
+                      </a>
+                    </li>
+
+
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="../../../user/index.html">
                         User Guide
                       </a>
                     </li>
 
 
-                    <li class="nav-item current active">
+                    <li class="nav-item">
                       <a class="nav-link nav-internal" href="../../index.html">
                         Developer Guide
                       </a>
@@ -303,14 +310,21 @@
 <nav class="navbar-nav">
   <ul class="bd-navbar-elements navbar-nav">
 
+                    <li class="nav-item current active">
+                      <a class="nav-link nav-internal" href="../decisions.html">
+                        Architectural Decision Records
+                      </a>
+                    </li>
+
+
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="../../../user/index.html">
                         User Guide
                       </a>
                     </li>
 
 
-                    <li class="nav-item current active">
+                    <li class="nav-item">
                       <a class="nav-link nav-internal" href="../../index.html">
                         Developer Guide
                       </a>
@@ -405,24 +419,9 @@
 <nav class="bd-docs-nav bd-links"
      aria-label="Section Navigation">
   <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
-  <div class="bd-toc-item navbar-nav"><p aria-level="2" class="caption" role="heading"><span class="caption-text">How-to Guides</span></p>
-<ul class="nav bd-sidenav">
-<li class="toctree-l1"><a class="reference internal" href="../../how-to/contribute.html">Contributing to the project</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../how-to/update-tools.html">Update the tools</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../how-to/make-release.html">Make a release</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../how-to/run-container.html">Run in a container</a></li>
-</ul>
-<p aria-level="2" class="caption" role="heading"><span class="caption-text">Explanations</span></p>
-<ul class="current nav bd-sidenav">
-<li class="toctree-l1 current active has-children"><a class="reference internal" href="../decisions.html">Architectural Decision Records</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
-<li class="toctree-l2 current active"><a class="current reference internal" href="#">1. Record architecture decisions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="0002-switched-to-pip-skeleton.html">2. Adopt python3-pip-skeleton for project structure</a></li>
-</ul>
-</li>
-</ul>
-<p aria-level="2" class="caption" role="heading"><span class="caption-text">Reference</span></p>
-<ul class="nav bd-sidenav">
-<li class="toctree-l1"><a class="reference internal" href="../../reference/standards.html">Standards</a></li>
+  <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
+<li class="toctree-l1 current active"><a class="current reference internal" href="#">1. Record architecture decisions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="0002-switched-to-pip-skeleton.html">2. Adopt python3-pip-skeleton for project structure</a></li>
 </ul>
 </div>
 </nav></div>
@@ -461,9 +460,6 @@
       </a>
     </li>
 
-    <li class="breadcrumb-item"><a href="../../index.html" class="nav-link">Developer Guide</a></li>
-
-
     <li class="breadcrumb-item"><a href="../decisions.html" class="nav-link">Architectural Decision Records</a></li>
 
     <li class="breadcrumb-item active" aria-current="page">1. Record...</li>

diff --git a/doc_changes/developer/explanations/decisions/0002-switched-to-pip-skeleton.html b/doc_changes/developer/explanations/decisions/0002-switched-to-pip-skeleton.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>2. Adopt python3-pip-skeleton for project structure &#8212; PandABlocks.github.io 3.1.dev11+g4b45523 documentation</title>
+    <title>2. Adopt python3-pip-skeleton for project structure &#8212; PandABlocks.github.io 3.1.dev12+gb29bca1 documentation</title>
 
 
 
@@ -39,7 +39,7 @@
 <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
   <script src="../../../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>
 
-    <script src="../../../_static/documentation_options.js?v=1e4f3aee"></script>
+    <script src="../../../_static/documentation_options.js?v=f0560c2c"></script>
     <script src="../../../_static/doctools.js?v=888ff710"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -55,7 +55,7 @@
     <link rel="icon" href="../../../_static/PandA-logo.ico"/>
     <link rel="index" title="Index" href="../../../genindex.html" />
     <link rel="search" title="Search" href="../../../search.html" />
-    <link rel="next" title="Standards" href="../../reference/standards.html" />
+    <link rel="next" title="User Guide" href="../../../user/index.html" />
     <link rel="prev" title="1. Record architecture decisions" href="0001-record-architecture-decisions.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
@@ -149,14 +149,21 @@
 <nav class="navbar-nav">
   <ul class="bd-navbar-elements navbar-nav">
 
+                    <li class="nav-item current active">
+                      <a class="nav-link nav-internal" href="../decisions.html">
+                        Architectural Decision Records
+                      </a>
+                    </li>
+
+
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="../../../user/index.html">
                         User Guide
                       </a>
                     </li>
 
 
-                    <li class="nav-item current active">
+                    <li class="nav-item">
                       <a class="nav-link nav-internal" href="../../index.html">
                         Developer Guide
                       </a>
@@ -303,14 +310,21 @@
 <nav class="navbar-nav">
   <ul class="bd-navbar-elements navbar-nav">
 
+                    <li class="nav-item current active">
+                      <a class="nav-link nav-internal" href="../decisions.html">
+                        Architectural Decision Records
+                      </a>
+                    </li>
+
+
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="../../../user/index.html">
                         User Guide
                       </a>
                     </li>
 
 
-                    <li class="nav-item current active">
+                    <li class="nav-item">
                       <a class="nav-link nav-internal" href="../../index.html">
                         Developer Guide
                       </a>
@@ -405,24 +419,9 @@
 <nav class="bd-docs-nav bd-links"
      aria-label="Section Navigation">
   <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
-  <div class="bd-toc-item navbar-nav"><p aria-level="2" class="caption" role="heading"><span class="caption-text">How-to Guides</span></p>
-<ul class="nav bd-sidenav">
-<li class="toctree-l1"><a class="reference internal" href="../../how-to/contribute.html">Contributing to the project</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../how-to/update-tools.html">Update the tools</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../how-to/make-release.html">Make a release</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../how-to/run-container.html">Run in a container</a></li>
-</ul>
-<p aria-level="2" class="caption" role="heading"><span class="caption-text">Explanations</span></p>
-<ul class="current nav bd-sidenav">
-<li class="toctree-l1 current active has-children"><a class="reference internal" href="../decisions.html">Architectural Decision Records</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="0001-record-architecture-decisions.html">1. Record architecture decisions</a></li>
-<li class="toctree-l2 current active"><a class="current reference internal" href="#">2. Adopt python3-pip-skeleton for project structure</a></li>
-</ul>
-</li>
-</ul>
-<p aria-level="2" class="caption" role="heading"><span class="caption-text">Reference</span></p>
-<ul class="nav bd-sidenav">
-<li class="toctree-l1"><a class="reference internal" href="../../reference/standards.html">Standards</a></li>
+  <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="0001-record-architecture-decisions.html">1. Record architecture decisions</a></li>
+<li class="toctree-l1 current active"><a class="current reference internal" href="#">2. Adopt python3-pip-skeleton for project structure</a></li>
 </ul>
 </div>
 </nav></div>
@@ -461,9 +460,6 @@
       </a>
     </li>
 
-    <li class="breadcrumb-item"><a href="../../index.html" class="nav-link">Developer Guide</a></li>
-
-
     <li class="breadcrumb-item"><a href="../decisions.html" class="nav-link">Architectural Decision Records</a></li>
 
     <li class="breadcrumb-item active" aria-current="page">2. Adopt...</li>
@@ -535,11 +531,11 @@ <h2>Consequences<a class="headerlink" href="#consequences" title="Link to this h
       </div>
     </a>
     <a class="right-next"
-       href="../../reference/standards.html"
+       href="../../../user/index.html"
        title="next page">
       <div class="prev-next-info">
         <p class="prev-next-subtitle">next</p>
-        <p class="prev-next-title">Standards</p>
+        <p class="prev-next-title">User Guide</p>
       </div>
       <i class="fa-solid fa-angle-right"></i>
     </a>