deploy: 3b943a0

CorrelAid · Dec 12, 2023 · e431e95 · e431e95
1 parent 1731d01
commit e431e95
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 18 deletions.
diff --git a/dev/genindex.html b/dev/genindex.html
@@ -203,12 +203,12 @@ <h2 id="G">G</h2>
       <li><a href="pystatis.html#pystatis.http_helper.get_data_from_endpoint">get_data_from_endpoint() (in module pystatis.http_helper)</a>
 </li>
       <li><a href="pystatis.html#pystatis.http_helper.get_data_from_resultfile">get_data_from_resultfile() (in module pystatis.http_helper)</a>
+</li>
+      <li><a href="pystatis.html#pystatis.config.get_db_identifiers">get_db_identifiers() (in module pystatis.config)</a>
 </li>
       <li><a href="pystatis.html#pystatis.http_helper.get_job_id_from_response">get_job_id_from_response() (in module pystatis.http_helper)</a>
 </li>
       <li><a href="pystatis.html#id3">get_metadata() (pystatis.find.Results method)</a>, <a href="pystatis.html#pystatis.find.Results.get_metadata">[1]</a>
-</li>
-      <li><a href="pystatis.html#pystatis.config.get_regex">get_regex() (in module pystatis.config)</a>
 </li>
       <li><a href="pystatis.html#pystatis.config.get_supported_db">get_supported_db() (in module pystatis.config)</a>
 </li>

diff --git a/dev/objects.inv b/dev/objects.inv
diff --git a/dev/pystatis.html b/dev/pystatis.html
@@ -71,7 +71,7 @@
 <li class="toctree-l3"><a class="reference internal" href="#pystatis.config.create_default_config"><code class="docutils literal notranslate"><span class="pre">create_default_config()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#pystatis.config.delete_config"><code class="docutils literal notranslate"><span class="pre">delete_config()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#pystatis.config.get_cache_dir"><code class="docutils literal notranslate"><span class="pre">get_cache_dir()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#pystatis.config.get_regex"><code class="docutils literal notranslate"><span class="pre">get_regex()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#pystatis.config.get_db_identifiers"><code class="docutils literal notranslate"><span class="pre">get_db_identifiers()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#pystatis.config.get_supported_db"><code class="docutils literal notranslate"><span class="pre">get_supported_db()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#pystatis.config.init_config"><code class="docutils literal notranslate"><span class="pre">init_config()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#pystatis.config.load_config"><code class="docutils literal notranslate"><span class="pre">load_config()</span></code></a></li>
@@ -366,8 +366,8 @@ <h1>pystatis package<a class="headerlink" href="#pystatis-package" title="Link t
 </dd></dl>
 
 <dl class="py function">
-<dt class="sig sig-object py" id="pystatis.config.get_regex">
-<span class="sig-prename descclassname"><span class="pre">pystatis.config.</span></span><span class="sig-name descname"><span class="pre">get_regex</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pystatis.config.get_regex" title="Link to this definition"></a></dt>
+<dt class="sig sig-object py" id="pystatis.config.get_db_identifiers">
+<span class="sig-prename descclassname"><span class="pre">pystatis.config.</span></span><span class="sig-name descname"><span class="pre">get_db_identifiers</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pystatis.config.get_db_identifiers" title="Link to this definition"></a></dt>
 <dd><p>Get a list of regex patterns matching item codes in the supported databases.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Return type<span class="colon">:</span></dt>
@@ -780,15 +780,18 @@ <h2>pystatis.custom_exceptions module<a class="headerlink" href="#pystatis-custo
 
 <dl class="py function">
 <dt class="sig sig-object py" id="pystatis.helloworld.whoami">
-<span class="sig-prename descclassname"><span class="pre">pystatis.helloworld.</span></span><span class="sig-name descname"><span class="pre">whoami</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pystatis.helloworld.whoami" title="Link to this definition"></a></dt>
-<dd><p>Wrapper method which constructs an URL for testing the Destatis API
+<span class="sig-prename descclassname"><span class="pre">pystatis.helloworld.</span></span><span class="sig-name descname"><span class="pre">whoami</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db_name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pystatis.helloworld.whoami" title="Link to this definition"></a></dt>
+<dd><p>Wrapper method which constructs a URL for testing the Destatis API
 whoami method, which returns host name and IP address.</p>
 <dl class="field-list simple">
-<dt class="field-odd">Returns<span class="colon">:</span></dt>
-<dd class="field-odd"><p>text test response from Destatis</p>
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>db_name</strong> (<em>str</em>) – Name of the database to test</p>
 </dd>
-<dt class="field-even">Return type<span class="colon">:</span></dt>
-<dd class="field-even"><p>str</p>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>text test response from Destatis</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>str</p>
 </dd>
 </dl>
 </dd></dl>
@@ -1211,15 +1214,18 @@ <h2>pystatis.custom_exceptions module<a class="headerlink" href="#pystatis-custo
 
 <dl class="py function">
 <dt class="sig sig-object py" id="pystatis.whoami">
-<span class="sig-prename descclassname"><span class="pre">pystatis.</span></span><span class="sig-name descname"><span class="pre">whoami</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pystatis.whoami" title="Link to this definition"></a></dt>
-<dd><p>Wrapper method which constructs an URL for testing the Destatis API
+<span class="sig-prename descclassname"><span class="pre">pystatis.</span></span><span class="sig-name descname"><span class="pre">whoami</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db_name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pystatis.whoami" title="Link to this definition"></a></dt>
+<dd><p>Wrapper method which constructs a URL for testing the Destatis API
 whoami method, which returns host name and IP address.</p>
 <dl class="field-list simple">
-<dt class="field-odd">Returns<span class="colon">:</span></dt>
-<dd class="field-odd"><p>text test response from Destatis</p>
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>db_name</strong> (<em>str</em>) – Name of the database to test</p>
 </dd>
-<dt class="field-even">Return type<span class="colon">:</span></dt>
-<dd class="field-even"><p>str</p>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>text test response from Destatis</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>str</p>
 </dd>
 </dl>
 </dd></dl>