Deploying to gh-pages from @ 9ae7240 🚀

sarnold · Dec 15, 2024 · 82a5aa5 · 82a5aa5
1 parent 10cb8ac
commit 82a5aa5
Show file tree

Hide file tree

Showing 22 changed files with 68 additions and 53 deletions.
diff --git a/.buildinfo b/.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: 2c64385525467c7cf35950d1f948cb73
+config: bd4de63c96cf5339708c014e28596246
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/README.html b/README.html
@@ -6,14 +6,14 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Pyserv - A Collection of Simple Servers &mdash; pyserv 1.6.0 documentation</title>
+  <title>Pyserv - A Collection of Simple Servers &mdash; pyserv 1.6.1.dev5+g9ae7240 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
 
 
       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="_static/documentation_options.js?v=72d88caf"></script>
+      <script src="_static/documentation_options.js?v=7c514f40"></script>
       <script src="_static/doctools.js?v=9a2dae69"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -177,6 +177,11 @@ <h3>Console command options<a class="headerlink" href="#console-command-options"
 <li><p>environment values are checked first; if not set, fallback to defaults</p></li>
 <li><p>logging using daemon package logger config</p></li>
 </ul>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The XDG runtime path may not exist in a console environment;
+if so, the fallback is XDG user cache path.</p>
+</div>
 <p>Sample environment display with tox overrides, ie, inside a <a class="reference external" href="https://github.com/tox-dev/tox">Tox</a> venv:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Python</span> <span class="n">version</span><span class="p">:</span> <span class="mf">3.11.4</span> <span class="p">(</span><span class="n">main</span><span class="p">,</span> <span class="n">Jul</span>  <span class="mi">5</span> <span class="mi">2023</span><span class="p">,</span> <span class="mi">16</span><span class="p">:</span><span class="mi">15</span><span class="p">:</span><span class="mi">04</span><span class="p">)</span> <span class="p">[</span><span class="n">GCC</span> <span class="mf">12.3.1</span> <span class="mi">20230526</span><span class="p">]</span>
 <span class="o">-------------------------------------------------------------------------------</span>

diff --git a/_modules/index.html b/_modules/index.html
@@ -5,14 +5,14 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Overview: module code &mdash; pyserv 1.6.0 documentation</title>
+  <title>Overview: module code &mdash; pyserv 1.6.1.dev5+g9ae7240 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../_static/jquery.js?v=5d32c60e"></script>
       <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../_static/documentation_options.js?v=72d88caf"></script>
+      <script src="../_static/documentation_options.js?v=7c514f40"></script>
       <script src="../_static/doctools.js?v=9a2dae69"></script>
       <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/js/theme.js"></script>

diff --git a/_modules/pyserv.html b/_modules/pyserv.html
@@ -5,14 +5,14 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>pyserv &mdash; pyserv 1.6.0 documentation</title>
+  <title>pyserv &mdash; pyserv 1.6.1.dev5+g9ae7240 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../_static/jquery.js?v=5d32c60e"></script>
       <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../_static/documentation_options.js?v=72d88caf"></script>
+      <script src="../_static/documentation_options.js?v=7c514f40"></script>
       <script src="../_static/doctools.js?v=9a2dae69"></script>
       <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/js/theme.js"></script>

diff --git a/_modules/pyserv/server.html b/_modules/pyserv/server.html
@@ -5,14 +5,14 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>pyserv.server &mdash; pyserv 1.6.0 documentation</title>
+  <title>pyserv.server &mdash; pyserv 1.6.1.dev5+g9ae7240 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../_static/documentation_options.js?v=72d88caf"></script>
+      <script src="../../_static/documentation_options.js?v=7c514f40"></script>
       <script src="../../_static/doctools.js?v=9a2dae69"></script>
       <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>

diff --git a/_modules/pyserv/settings.html b/_modules/pyserv/settings.html
@@ -5,14 +5,14 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>pyserv.settings &mdash; pyserv 1.6.0 documentation</title>
+  <title>pyserv.settings &mdash; pyserv 1.6.1.dev5+g9ae7240 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../_static/documentation_options.js?v=72d88caf"></script>
+      <script src="../../_static/documentation_options.js?v=7c514f40"></script>
       <script src="../../_static/doctools.js?v=9a2dae69"></script>
       <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>
@@ -93,8 +93,10 @@ <h1>Source code for pyserv.settings</h1><div class="highlight"><pre>
 <span class="sd">    :return tuple: logdir, piddir, docdir as Path objs</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">dirs</span> <span class="o">=</span> <span class="n">PlatformDirs</span><span class="p">(</span><span class="n">appname</span><span class="o">=</span><span class="s1">&#39;pyserv&#39;</span><span class="p">,</span> <span class="n">appauthor</span><span class="o">=</span><span class="s1">&#39;nerdboy&#39;</span><span class="p">)</span>
+    <span class="n">run_check</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="s1">&#39;/run/user&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">exists</span><span class="p">()</span>
+    <span class="n">run_path</span> <span class="o">=</span> <span class="n">dirs</span><span class="o">.</span><span class="n">user_runtime_path</span> <span class="k">if</span> <span class="n">run_check</span> <span class="k">else</span> <span class="n">dirs</span><span class="o">.</span><span class="n">user_cache_path</span>
     <span class="n">logdir</span> <span class="o">=</span> <span class="n">dirs</span><span class="o">.</span><span class="n">user_log_path</span>
-    <span class="n">piddir</span> <span class="o">=</span> <span class="n">dirs</span><span class="o">.</span><span class="n">user_runtime_path</span>
+    <span class="n">piddir</span> <span class="o">=</span> <span class="n">run_path</span>
     <span class="n">docdir</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">())</span>
     <span class="k">return</span> <span class="n">logdir</span><span class="p">,</span> <span class="n">piddir</span><span class="p">,</span> <span class="n">docdir</span></div>
 
@@ -116,13 +118,12 @@ <h1>Source code for pyserv.settings</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="platform_check">
 <a class="viewcode-back" href="../../api/pyserv.settings.html#pyserv.settings.platform_check">[docs]</a>
-<span class="k">def</span> <span class="nf">platform_check</span><span class="p">():</span>
+<span class="k">def</span> <span class="nf">platform_check</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Check to see if we think we are POSIX.</span>
 
-<span class="sd">    :return bool: True if POSIX, else False</span>
+<span class="sd">    :return we_are_posix: true if system is posix</span>
 <span class="sd">    &quot;&quot;&quot;</span>
-    <span class="n">valid_os</span> <span class="o">=</span> <span class="p">[]</span>
     <span class="n">myname</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">platform</span>
     <span class="n">is_posix</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="s1">&#39;posix&#39;</span>
     <span class="n">posix_list</span> <span class="o">=</span> <span class="p">[</span>
@@ -131,9 +132,8 @@ <h1>Source code for pyserv.settings</h1><div class="highlight"><pre>
         <span class="s1">&#39;openbsd&#39;</span><span class="p">,</span>
         <span class="s1">&#39;freebsd&#39;</span><span class="p">,</span>
     <span class="p">]</span>
-    <span class="n">valid_os</span> <span class="o">=</span> <span class="p">[</span><span class="n">x</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">posix_list</span> <span class="k">if</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">myname</span> <span class="ow">and</span> <span class="n">is_posix</span><span class="p">]</span>
-
-    <span class="k">return</span> <span class="n">valid_os</span></div>
+    <span class="n">we_are_posix</span> <span class="o">=</span> <span class="n">myname</span> <span class="ow">in</span> <span class="n">posix_list</span> <span class="ow">and</span> <span class="n">is_posix</span>
+    <span class="k">return</span> <span class="n">we_are_posix</span></div>
 
 
 

diff --git a/_modules/pyserv/tftpd.html b/_modules/pyserv/tftpd.html
@@ -5,14 +5,14 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>pyserv.tftpd &mdash; pyserv 1.6.0 documentation</title>
+  <title>pyserv.tftpd &mdash; pyserv 1.6.1.dev5+g9ae7240 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../_static/documentation_options.js?v=72d88caf"></script>
+      <script src="../../_static/documentation_options.js?v=7c514f40"></script>
       <script src="../../_static/doctools.js?v=9a2dae69"></script>
       <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>

diff --git a/_modules/pyserv/wsgi.html b/_modules/pyserv/wsgi.html
@@ -5,14 +5,14 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>pyserv.wsgi &mdash; pyserv 1.6.0 documentation</title>
+  <title>pyserv.wsgi &mdash; pyserv 1.6.1.dev5+g9ae7240 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../_static/documentation_options.js?v=72d88caf"></script>
+      <script src="../../_static/documentation_options.js?v=7c514f40"></script>
       <script src="../../_static/doctools.js?v=9a2dae69"></script>
       <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>

diff --git a/_sources/README.rst.txt b/_sources/README.rst.txt
@@ -101,6 +101,10 @@ adjustable via environment variables, and the following "extra" features:
 * environment values are checked first; if not set, fallback to defaults
 * logging using daemon package logger config
 
+.. note:: The XDG runtime path may not exist in a console environment;
+          if so, the fallback is XDG user cache path.
+
+
 Sample environment display with tox overrides, ie, inside a Tox_ venv::
 
   Python version: 3.11.4 (main, Jul  5 2023, 16:15:04) [GCC 12.3.1 20230526]

diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '1.6.0',
+    VERSION: '1.6.1.dev5+g9ae7240',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/_static/js/versions.js b/_static/js/versions.js
@@ -1,17 +1,21 @@
 const themeFlyoutDisplay = "hidden";
-const themeVersionSelector = "True";
-const themeLanguageSelector = "True";
+const themeVersionSelector = true;
+const themeLanguageSelector = true;
 
 if (themeFlyoutDisplay === "attached") {
   function renderLanguages(config) {
     if (!config.projects.translations.length) {
       return "";
     }
 
+    // Insert the current language to the options on the selector
+    let languages = config.projects.translations.concat(config.projects.current);
+    languages = languages.sort((a, b) => a.language.name.localeCompare(b.language.name));
+
     const languagesHTML = `
       <dl>
         <dt>Languages</dt>
-        ${config.projects.translations
+        ${languages
           .map(
             (translation) => `
         <dd ${translation.slug == config.projects.current.slug ? 'class="rtd-current-item"' : ""}>

diff --git a/api/modules.html b/api/modules.html
@@ -6,14 +6,14 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>pyserv &mdash; pyserv 1.6.0 documentation</title>
+  <title>pyserv &mdash; pyserv 1.6.1.dev5+g9ae7240 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../_static/jquery.js?v=5d32c60e"></script>
       <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../_static/documentation_options.js?v=72d88caf"></script>
+      <script src="../_static/documentation_options.js?v=7c514f40"></script>
       <script src="../_static/doctools.js?v=9a2dae69"></script>
       <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/js/theme.js"></script>

diff --git a/api/pyserv.html b/api/pyserv.html
@@ -6,14 +6,14 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>pyserv package &mdash; pyserv 1.6.0 documentation</title>
+  <title>pyserv package &mdash; pyserv 1.6.1.dev5+g9ae7240 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../_static/jquery.js?v=5d32c60e"></script>
       <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../_static/documentation_options.js?v=72d88caf"></script>
+      <script src="../_static/documentation_options.js?v=7c514f40"></script>
       <script src="../_static/doctools.js?v=9a2dae69"></script>
       <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/js/theme.js"></script>

diff --git a/api/pyserv.server.html b/api/pyserv.server.html
@@ -6,14 +6,14 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>pyserv.server module &mdash; pyserv 1.6.0 documentation</title>
+  <title>pyserv.server module &mdash; pyserv 1.6.1.dev5+g9ae7240 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../_static/jquery.js?v=5d32c60e"></script>
       <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../_static/documentation_options.js?v=72d88caf"></script>
+      <script src="../_static/documentation_options.js?v=7c514f40"></script>
       <script src="../_static/doctools.js?v=9a2dae69"></script>
       <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/js/theme.js"></script>

diff --git a/api/pyserv.settings.html b/api/pyserv.settings.html
@@ -6,14 +6,14 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>pyserv.settings module &mdash; pyserv 1.6.0 documentation</title>
+  <title>pyserv.settings module &mdash; pyserv 1.6.1.dev5+g9ae7240 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../_static/jquery.js?v=5d32c60e"></script>
       <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../_static/documentation_options.js?v=72d88caf"></script>
+      <script src="../_static/documentation_options.js?v=7c514f40"></script>
       <script src="../_static/doctools.js?v=9a2dae69"></script>
       <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/js/theme.js"></script>
@@ -115,11 +115,11 @@
 
 <dl class="py function">
 <dt class="sig sig-object py" id="pyserv.settings.platform_check">
-<span class="sig-prename descclassname"><span class="pre">pyserv.settings.</span></span><span class="sig-name descname"><span class="pre">platform_check</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyserv/settings.html#platform_check"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyserv.settings.platform_check" title="Link to this definition"></a></dt>
+<span class="sig-prename descclassname"><span class="pre">pyserv.settings.</span></span><span class="sig-name descname"><span class="pre">platform_check</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="reference internal" href="../_modules/pyserv/settings.html#platform_check"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyserv.settings.platform_check" title="Link to this definition"></a></dt>
 <dd><p>Check to see if we think we are POSIX.</p>
 <dl class="field-list simple">
-<dt class="field-odd">Return bool<span class="colon">:</span></dt>
-<dd class="field-odd"><p>True if POSIX, else False</p>
+<dt class="field-odd">Return we_are_posix<span class="colon">:</span></dt>
+<dd class="field-odd"><p>true if system is posix</p>
 </dd>
 </dl>
 </dd></dl>