deploy: 1cb6067

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

Hide file tree

Showing 30 changed files with 1,682 additions and 222 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: 776f0dc0f4e8b1b44ad04609776e6086
+config: 6c9adf35f3448e1bd1b3a262821708bd
 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
@@ -15,12 +15,16 @@ The documentation is split into 2 sections:
         :link: user/index
         :link-type: doc
 
+        +++
+
         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
 
+        +++
+
         The Developer Guide contains documentation on how to develop and contribute changes back to PandABlocks.github.io.
 
     .. grid-item-card:: :material-regular:`info;3em`
@@ -30,9 +34,26 @@ The documentation is split into 2 sections:
             :maxdepth: 1
 
 	    developer/explanations/decisions
+
+        +++
 
 	Explanations of how and why the architecture is why it is.
 
+    .. grid-item-card:: :material-regular:`menu_book;3em`
+
+        .. toctree::
+            :caption: Reference
+            :maxdepth: 1
+
+	    developer/reference/standards
+            user/reference/migration_guide
+            user/reference/release_compatibility
+            ../genindex
+
+        +++
+
+        Technical reference material including APIs and release notes.
+
 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.dev12+gb29bca1',
+    VERSION: '3.1.dev13+g1cb6067',
     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.dev12+gb29bca1 documentation</title>
+    <title>Architectural Decision Records &#8212; PandABlocks.github.io 3.1.dev13+g1cb6067 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=f0560c2c"></script>
+    <script src="../../_static/documentation_options.js?v=ef20b916"></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>
@@ -157,25 +157,61 @@
 
 
                     <li class="nav-item">
-                      <a class="nav-link nav-internal" href="../../user/index.html">
+                      <a class="nav-link 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">
+                        Migration Guide
+                      </a>
+                    </li>
+
+
+                    <li class="nav-item">
+                      <a class="nav-link 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">
+                        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
                       </a>
                     </li>
 
 
                     <li class="nav-item">
-                      <a class="nav-link nav-internal" href="../index.html">
+                      <a class="nav-link dropdown-item nav-internal" href="../index.html">
                         Developer Guide
                       </a>
                     </li>
 
 
                 <li class="nav-item">
-                  <a class="nav-link nav-external" href="https://github.com/PandABlocks/PandABlocks.github.io/releases">
+                  <a class="nav-link dropdown-item nav-external" href="https://github.com/PandABlocks/PandABlocks.github.io/releases">
                     Release Notes
                   </a>
                 </li>
 
+                </ul>
+            </li>
+
   </ul>
 </nav></div>
 
@@ -318,25 +354,61 @@
 
 
                     <li class="nav-item">
-                      <a class="nav-link nav-internal" href="../../user/index.html">
+                      <a class="nav-link 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">
+                        Migration Guide
+                      </a>
+                    </li>
+
+
+                    <li class="nav-item">
+                      <a class="nav-link 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">
+                        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
                       </a>
                     </li>
 
 
                     <li class="nav-item">
-                      <a class="nav-link nav-internal" href="../index.html">
+                      <a class="nav-link dropdown-item nav-internal" href="../index.html">
                         Developer Guide
                       </a>
                     </li>
 
 
                 <li class="nav-item">
-                  <a class="nav-link nav-external" href="https://github.com/PandABlocks/PandABlocks.github.io/releases">
+                  <a class="nav-link dropdown-item nav-external" href="https://github.com/PandABlocks/PandABlocks.github.io/releases">
                     Release Notes
                   </a>
                 </li>
 
+                </ul>
+            </li>
+
   </ul>
 </nav></div>
 

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.dev12+gb29bca1 documentation</title>
+    <title>1. Record architecture decisions &#8212; PandABlocks.github.io 3.1.dev13+g1cb6067 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=f0560c2c"></script>
+    <script src="../../../_static/documentation_options.js?v=ef20b916"></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>
@@ -157,25 +157,61 @@
 
 
                     <li class="nav-item">
-                      <a class="nav-link nav-internal" href="../../../user/index.html">
+                      <a class="nav-link 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">
+                        Migration Guide
+                      </a>
+                    </li>
+
+
+                    <li class="nav-item">
+                      <a class="nav-link 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">
+                        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
                       </a>
                     </li>
 
 
                     <li class="nav-item">
-                      <a class="nav-link nav-internal" href="../../index.html">
+                      <a class="nav-link dropdown-item nav-internal" href="../../index.html">
                         Developer Guide
                       </a>
                     </li>
 
 
                 <li class="nav-item">
-                  <a class="nav-link nav-external" href="https://github.com/PandABlocks/PandABlocks.github.io/releases">
+                  <a class="nav-link dropdown-item nav-external" href="https://github.com/PandABlocks/PandABlocks.github.io/releases">
                     Release Notes
                   </a>
                 </li>
 
+                </ul>
+            </li>
+
   </ul>
 </nav></div>
 
@@ -318,25 +354,61 @@
 
 
                     <li class="nav-item">
-                      <a class="nav-link nav-internal" href="../../../user/index.html">
+                      <a class="nav-link 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">
+                        Migration Guide
+                      </a>
+                    </li>
+
+
+                    <li class="nav-item">
+                      <a class="nav-link 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">
+                        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
                       </a>
                     </li>
 
 
                     <li class="nav-item">
-                      <a class="nav-link nav-internal" href="../../index.html">
+                      <a class="nav-link dropdown-item nav-internal" href="../../index.html">
                         Developer Guide
                       </a>
                     </li>
 
 
                 <li class="nav-item">
-                  <a class="nav-link nav-external" href="https://github.com/PandABlocks/PandABlocks.github.io/releases">
+                  <a class="nav-link dropdown-item nav-external" href="https://github.com/PandABlocks/PandABlocks.github.io/releases">
                     Release Notes
                   </a>
                 </li>
 
+                </ul>
+            </li>
+
   </ul>
 </nav></div>