Merge pull request #9 from qiqb-osaka/feature-update-docs

update document

docs_html/quri_parts/riqu/quri_parts.riqu.backend.html

@@ -273,6 +273,18 @@
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">default</span><span class="p">]</span>
 <span class="n">url</span><span class="o">=&lt;</span><span class="n">base</span> <span class="n">URL</span><span class="o">&gt;</span>
 <span class="n">api_token</span><span class="o">=&lt;</span><span class="n">API</span> <span class="n">token</span><span class="o">&gt;</span>
+
+<span class="p">[</span><span class="n">sectionA</span><span class="p">]</span>
+<span class="n">url</span><span class="o">=&lt;</span><span class="n">base</span> <span class="n">URL</span><span class="o">&gt;</span>
+<span class="n">api_token</span><span class="o">=&lt;</span><span class="n">API</span> <span class="n">token</span><span class="o">&gt;</span>
+
+<span class="p">[</span><span class="n">sectioB</span><span class="p">]</span>
+<span class="n">url</span><span class="o">=&lt;</span><span class="n">base</span> <span class="n">URL</span><span class="o">&gt;</span>
+<span class="n">api_token</span><span class="o">=&lt;</span><span class="n">API</span> <span class="n">token</span><span class="o">&gt;</span>
+</pre></div>
+</div>
+<p>If <code class="docutils literal notranslate"><span class="pre">sectionA</span></code> settings are to be used, initialize <code class="docutils literal notranslate"><span class="pre">RiquSamplingBackend</span></code> as follows</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">backend</span> <span class="o">=</span> <span class="n">RiquSamplingBackend</span><span class="p">(</span><span class="n">RiquConfig</span><span class="o">.</span><span class="n">from_file</span><span class="p">(</span><span class="s2">&quot;sectionA&quot;</span><span class="p">))</span>
 </pre></div>
 </div>
 </dd></dl>

docs_html/quri_parts/riqu/quri_parts.riqu.backend.sampling.html

@@ -542,6 +542,18 @@
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">default</span><span class="p">]</span>
 <span class="n">url</span><span class="o">=&lt;</span><span class="n">base</span> <span class="n">URL</span><span class="o">&gt;</span>
 <span class="n">api_token</span><span class="o">=&lt;</span><span class="n">API</span> <span class="n">token</span><span class="o">&gt;</span>
+
+<span class="p">[</span><span class="n">sectionA</span><span class="p">]</span>
+<span class="n">url</span><span class="o">=&lt;</span><span class="n">base</span> <span class="n">URL</span><span class="o">&gt;</span>
+<span class="n">api_token</span><span class="o">=&lt;</span><span class="n">API</span> <span class="n">token</span><span class="o">&gt;</span>
+
+<span class="p">[</span><span class="n">sectioB</span><span class="p">]</span>
+<span class="n">url</span><span class="o">=&lt;</span><span class="n">base</span> <span class="n">URL</span><span class="o">&gt;</span>
+<span class="n">api_token</span><span class="o">=&lt;</span><span class="n">API</span> <span class="n">token</span><span class="o">&gt;</span>
+</pre></div>
+</div>
+<p>If <code class="docutils literal notranslate"><span class="pre">sectionA</span></code> settings are to be used, initialize <code class="docutils literal notranslate"><span class="pre">RiquSamplingBackend</span></code> as follows</p>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">backend</span> <span class="o">=</span> <span class="n">RiquSamplingBackend</span><span class="p">(</span><span class="n">RiquConfig</span><span class="o">.</span><span class="n">from_file</span><span class="p">(</span><span class="s2">&quot;sectionA&quot;</span><span class="p">))</span>
 </pre></div>
 </div>
 </dd></dl>

quri_parts/riqu/backend/sampling.py

@@ -406,6 +406,21 @@ def from_file(section: str = "default", path: str = "~/.riqu") -> "RiquConfig":
                 [default]
                 url=<base URL>
                 api_token=<API token>
+
+                [sectionA]
+                url=<base URL>
+                api_token=<API token>
+
+                [sectioB]
+                url=<base URL>
+                api_token=<API token>
+
+            If ``sectionA`` settings are to be used, initialize ``RiquSamplingBackend`` as follows
+
+            .. code-block::
+
+                backend = RiquSamplingBackend(RiquConfig.from_file("sectionA"))
+
         """
         path = os.path.expandvars(path)
         path = os.path.expanduser(path)