deploy: 4481ffe

PandABlocks · Mar 22, 2024 · b4c33c3 · b4c33c3
1 parent e469aa6
commit b4c33c3
Show file tree

Hide file tree

Showing 30 changed files with 1,634 additions and 586 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: 6c9adf35f3448e1bd1b3a262821708bd
+config: ed85a96cdcd1608949a944aea4bf319a
 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
@@ -19,13 +19,20 @@ The documentation is split into 2 sections:
 
         The User Guide contains documentation on how to install and use PandABlocks.github.io.
 
-    .. grid-item-card:: :material-regular:`code;4em`
-        :link: developer/index
-        :link-type: doc
+    .. grid-item-card:: :material-regular:`task;3em`
+
+        .. toctree::
+            :caption: How-to Guides
+            :maxdepth: 1
+
+            developer/how-to/contribute
+            developer/how-to/update-tools
+            developer/how-to/make-release
+            developer/how-to/run-container
 
         +++
 
-        The Developer Guide contains documentation on how to develop and contribute changes back to PandABlocks.github.io.
+        Practical step-by-step guides for day-to-day dev tasks and experienced users.
 
     .. grid-item-card:: :material-regular:`info;3em`
 

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.dev13+g1cb6067',
+    VERSION: '3.1.dev14+g4481ffe',
     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.dev13+g1cb6067 documentation</title>
+    <title>Architectural Decision Records &#8212; PandABlocks.github.io 3.1.dev14+g4481ffe 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=ef20b916"></script>
+    <script src="../../_static/documentation_options.js?v=4e7c6c81"></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="PandABlocks.github.io" href="../../index.html" />
+    <link rel="prev" title="Run in a container" href="../how-to/run-container.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
   </head>
@@ -149,46 +149,74 @@
 <nav class="navbar-nav">
   <ul class="bd-navbar-elements navbar-nav">
 
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../how-to/contribute.html">
+                        Contributing to the project
+                      </a>
+                    </li>
+
+
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../how-to/update-tools.html">
+                        Update the tools
+                      </a>
+                    </li>
+
+
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../how-to/make-release.html">
+                        Make a release
+                      </a>
+                    </li>
+
+
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../how-to/run-container.html">
+                        Run in a container
+                      </a>
+                    </li>
+
+
                     <li class="nav-item current active">
                       <a class="nav-link nav-internal" href="#">
                         Architectural Decision Records
                       </a>
                     </li>
 
-
+            <li class="nav-item dropdown">
+                <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links">
+                    More
+                </button>
+                <ul id="pst-nav-more-links" class="dropdown-menu">
+
                     <li class="nav-item">
-                      <a class="nav-link nav-internal" href="../reference/standards.html">
+                      <a class="nav-link dropdown-item nav-internal" href="../reference/standards.html">
                         Standards
                       </a>
                     </li>
 
 
                     <li class="nav-item">
-                      <a class="nav-link nav-internal" href="../../user/reference/migration_guide.html">
+                      <a class="nav-link dropdown-item nav-internal" href="../../user/reference/migration_guide.html">
                         Migration Guide
                       </a>
                     </li>
 
 
                     <li class="nav-item">
-                      <a class="nav-link nav-internal" href="../../user/reference/release_compatibility.html">
+                      <a class="nav-link dropdown-item nav-internal" href="../../user/reference/release_compatibility.html">
                         Release Compatibility table
                       </a>
                     </li>
 
 
                     <li class="nav-item">
-                      <a class="nav-link nav-internal" href="../../genindex.html">
+                      <a class="nav-link dropdown-item nav-internal" href="../../genindex.html">
                         API Index
                       </a>
                     </li>
 
-            <li class="nav-item dropdown">
-                <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links">
-                    More
-                </button>
-                <ul id="pst-nav-more-links" class="dropdown-menu">
-
+
                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-internal" href="../../user/index.html">
                         User Guide
@@ -346,46 +374,74 @@
 <nav class="navbar-nav">
   <ul class="bd-navbar-elements navbar-nav">
 
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../how-to/contribute.html">
+                        Contributing to the project
+                      </a>
+                    </li>
+
+
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../how-to/update-tools.html">
+                        Update the tools
+                      </a>
+                    </li>
+
+
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../how-to/make-release.html">
+                        Make a release
+                      </a>
+                    </li>
+
+
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../how-to/run-container.html">
+                        Run in a container
+                      </a>
+                    </li>
+
+
                     <li class="nav-item current active">
                       <a class="nav-link nav-internal" href="#">
                         Architectural Decision Records
                       </a>
                     </li>
 
-
+            <li class="nav-item dropdown">
+                <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links-2">
+                    More
+                </button>
+                <ul id="pst-nav-more-links-2" class="dropdown-menu">
+
                     <li class="nav-item">
-                      <a class="nav-link nav-internal" href="../reference/standards.html">
+                      <a class="nav-link dropdown-item nav-internal" href="../reference/standards.html">
                         Standards
                       </a>
                     </li>
 
 
                     <li class="nav-item">
-                      <a class="nav-link nav-internal" href="../../user/reference/migration_guide.html">
+                      <a class="nav-link dropdown-item nav-internal" href="../../user/reference/migration_guide.html">
                         Migration Guide
                       </a>
                     </li>
 
 
                     <li class="nav-item">
-                      <a class="nav-link nav-internal" href="../../user/reference/release_compatibility.html">
+                      <a class="nav-link dropdown-item nav-internal" href="../../user/reference/release_compatibility.html">
                         Release Compatibility table
                       </a>
                     </li>
 
 
                     <li class="nav-item">
-                      <a class="nav-link nav-internal" href="../../genindex.html">
+                      <a class="nav-link dropdown-item nav-internal" href="../../genindex.html">
                         API Index
                       </a>
                     </li>
 
-            <li class="nav-item dropdown">
-                <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links-2">
-                    More
-                </button>
-                <ul id="pst-nav-more-links-2" class="dropdown-menu">
-
+
                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-internal" href="../../user/index.html">
                         User Guide
@@ -572,12 +628,12 @@ <h1>Architectural Decision Records<a class="headerlink" href="#architectural-dec
 
 <div class="prev-next-area">
     <a class="left-prev"
-       href="../../index.html"
+       href="../how-to/run-container.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">PandABlocks.github.io</p>
+        <p class="prev-next-title">Run in a container</p>
       </div>
     </a>
     <a class="right-next"