Auto-update from Github Actions Workflow

Deployed from commit 2e7e6d3 (refs/heads/master) Deployed from commit 69e353a (refs/heads/master)
goerz · Jun 4, 2024 · a98b382 · a98b382
1 parent 9795c9b
commit a98b382
Show file tree

Hide file tree

Showing 17 changed files with 42 additions and 38 deletions.
diff --git a/master/.buildinfo b/master/.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: 411845e7d1071c88d653047d8d5bece5
+config: e6088d21358bf35ae78d2676d58cccb6
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/master/_static/documentation_options.js b/master/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.5.2+dev (3c2fafc)',
+    VERSION: '0.5.2+dev (69e353a)',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/master/authors.html b/master/authors.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Credits &#8212; Docs Versions Menu 0.5.2+dev (3c2fafc) documentation</title>
+    <title>Credits &#8212; Docs Versions Menu 0.5.2+dev (69e353a) documentation</title>
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -117,7 +117,7 @@ <h3 id="searchlabel">Quick search</h3>
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy;2023, Michael Goerz.
+      &copy;2024, Michael Goerz.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.3</a>

diff --git a/master/contributing.html b/master/contributing.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Contributing &#8212; Docs Versions Menu 0.5.2+dev (3c2fafc) documentation</title>
+    <title>Contributing &#8212; Docs Versions Menu 0.5.2+dev (69e353a) documentation</title>
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -320,7 +320,7 @@ <h3 id="searchlabel">Quick search</h3>
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy;2023, Michael Goerz.
+      &copy;2024, Michael Goerz.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.3</a>

diff --git a/master/deployment.html b/master/deployment.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Step 2: Deployment &#8212; Docs Versions Menu 0.5.2+dev (3c2fafc) documentation</title>
+    <title>Step 2: Deployment &#8212; Docs Versions Menu 0.5.2+dev (69e353a) documentation</title>
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -102,7 +102,7 @@
 </ul>
 <p>For example, consider the following workflow step:</p>
 <div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Deploy documentation to gh-pages</span>
-  <span class="nt">if</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">github.ref == &#39;refs/heads/master&#39; || startsWith(github.ref, &#39;refs/tags/&#39;)</span>
+  <span class="nt">if</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">github.ref == &#39;refs/heads/master&#39; || github.ref == &#39;refs/heads/rtd-theme&#39; || startsWith(github.ref, &#39;refs/tags/&#39;)</span>
   <span class="nt">shell</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">bash</span>
   <span class="nt">run</span><span class="p">:</span> <span class="p p-Indicator">|</span>
     <span class="no">set -x</span>
@@ -137,7 +137,7 @@
   <span class="nt">env</span><span class="p">:</span>
     <span class="nt">DOCS_VERSIONS_MENU_DEBUG</span><span class="p">:</span> <span class="s">&#39;true&#39;</span>
     <span class="nt">DOCS_VERSIONS_MENU_VERSIONS</span><span class="p">:</span> <span class="s">&#39;(&lt;branches&gt;</span><span class="nv"> </span><span class="s">!=</span><span class="nv"> </span><span class="s">(master,</span><span class="nv"> </span><span class="s">rtd-theme)),</span><span class="nv"> </span><span class="s">(&lt;releases&gt;)[:-1],</span><span class="nv"> </span><span class="s">rtd-theme,</span><span class="nv"> </span><span class="s">(&lt;releases&gt;)[-1],</span><span class="nv"> </span><span class="s">master&#39;</span>
-    <span class="nt">DOCS_VERSIONS_MENU_LABEL</span><span class="p">:</span> <span class="s">&#39;rtd-theme:</span><span class="nv"> </span><span class="s">v0.4.1</span><span class="nv"> </span><span class="s">(rtd-theme)&#39;</span>
+    <span class="nt">DOCS_VERSIONS_MENU_LABEL</span><span class="p">:</span> <span class="s">&#39;rtd-theme:</span><span class="nv"> </span><span class="s">v0.5.2</span><span class="nv"> </span><span class="s">(rtd-theme)&#39;</span>
     <span class="nt">DOCS_VERSIONS_MENU_WARNING</span><span class="p">:</span> <span class="s">&#39;unreleased:</span><span class="nv"> </span><span class="s">(&lt;branches&gt;</span><span class="nv"> </span><span class="s">!=</span><span class="nv"> </span><span class="s">rtd-theme),</span><span class="nv"> </span><span class="s">&lt;local-releases&gt;&#39;</span>
     <span class="nt">GITHUB_ACTOR</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">${{ secrets.GITHUB_ACTOR }}</span>
     <span class="nt">GITHUB_TOKEN</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">${{ secrets.GITHUB_TOKEN }}</span>
@@ -312,7 +312,7 @@ <h3 id="searchlabel">Quick search</h3>
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy;2023, Michael Goerz.
+      &copy;2024, Michael Goerz.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.3</a>

diff --git a/master/folderspecs.html b/master/folderspecs.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Folder Specifications &#8212; Docs Versions Menu 0.5.2+dev (3c2fafc) documentation</title>
+    <title>Folder Specifications &#8212; Docs Versions Menu 0.5.2+dev (69e353a) documentation</title>
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -242,7 +242,7 @@ <h3 id="searchlabel">Quick search</h3>
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy;2023, Michael Goerz.
+      &copy;2024, Michael Goerz.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.3</a>

diff --git a/master/genindex.html b/master/genindex.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; Docs Versions Menu 0.5.2+dev (3c2fafc) documentation</title>
+    <title>Index &#8212; Docs Versions Menu 0.5.2+dev (69e353a) documentation</title>
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -298,7 +298,7 @@ <h3 id="searchlabel">Quick search</h3>
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy;2023, Michael Goerz.
+      &copy;2024, Michael Goerz.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.3</a>

diff --git a/master/history.html b/master/history.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>History &#8212; Docs Versions Menu 0.5.2+dev (3c2fafc) documentation</title>
+    <title>History &#8212; Docs Versions Menu 0.5.2+dev (69e353a) documentation</title>
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -238,7 +238,7 @@ <h3 id="searchlabel">Quick search</h3>
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy;2023, Michael Goerz.
+      &copy;2024, Michael Goerz.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.3</a>

diff --git a/master/index.html b/master/index.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Welcome to the Docs Versions Menu documentation &#8212; Docs Versions Menu 0.5.2+dev (3c2fafc) documentation</title>
+    <title>Welcome to the Docs Versions Menu documentation &#8212; Docs Versions Menu 0.5.2+dev (69e353a) documentation</title>
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -186,7 +186,7 @@ <h3 id="searchlabel">Quick search</h3>
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy;2023, Michael Goerz.
+      &copy;2024, Michael Goerz.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.3</a>

diff --git a/master/options.html b/master/options.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Program Options &#8212; Docs Versions Menu 0.5.2+dev (3c2fafc) documentation</title>
+    <title>Program Options &#8212; Docs Versions Menu 0.5.2+dev (69e353a) documentation</title>
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -369,7 +369,7 @@ <h3 id="searchlabel">Quick search</h3>
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy;2023, Michael Goerz.
+      &copy;2024, Michael Goerz.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.3</a>

diff --git a/master/readme.html b/master/readme.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Getting Started &#8212; Docs Versions Menu 0.5.2+dev (3c2fafc) documentation</title>
+    <title>Getting Started &#8212; Docs Versions Menu 0.5.2+dev (69e353a) documentation</title>
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -80,6 +80,10 @@ <h2>Installation<a class="headerlink" href="#installation" title="Permalink to t
 </div>
 <div class="section" id="usage">
 <h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
+<div class="admonition warning">
+<p class="admonition-title">Warning</p>
+<p>This plugin currently relies on jQuery, which is <a class="reference external" href="https://github.com/sphinx-doc/sphinx/blob/548f0f928aab7c8f373604a0f65cce962e9807a5/CHANGES.rst#incompatible-changes-5">no longer automatically included in Sphinx &gt;= 6.0</a>. You may need to add <code class="docutils literal notranslate"><span class="pre">sphinxcontrib.jquery</span></code> to the extensions list in <code class="docutils literal notranslate"><span class="pre">conf.py</span></code> in order for the versions menu to appear.</p>
+</div>
 <p>Showing a versions-menu in your documentation requires two steps:</p>
 <ol class="arabic">
 <li><p>Add <code class="docutils literal notranslate"><span class="pre">'docs_versions_menu'</span></code> to the list of extensions in your Sphinx <code class="docutils literal notranslate"><span class="pre">conf.py</span></code>.</p>
@@ -190,7 +194,7 @@ <h3 id="searchlabel">Quick search</h3>
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy;2023, Michael Goerz.
+      &copy;2024, Michael Goerz.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.3</a>

diff --git a/master/related_software.html b/master/related_software.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Related software &#8212; Docs Versions Menu 0.5.2+dev (3c2fafc) documentation</title>
+    <title>Related software &#8212; Docs Versions Menu 0.5.2+dev (69e353a) documentation</title>
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -163,7 +163,7 @@ <h3 id="searchlabel">Quick search</h3>
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy;2023, Michael Goerz.
+      &copy;2024, Michael Goerz.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.3</a>

diff --git a/master/search.html b/master/search.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Search &#8212; Docs Versions Menu 0.5.2+dev (3c2fafc) documentation</title>
+    <title>Search &#8212; Docs Versions Menu 0.5.2+dev (69e353a) documentation</title>
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -109,7 +109,7 @@ <h3>Need help?</h3>
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy;2023, Michael Goerz.
+      &copy;2024, Michael Goerz.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.3</a>