Deploying to gh-pages from @ f713074 🚀

api.html

@@ -580,6 +580,22 @@ <h1>API documentation<a class="headerlink" href="#api-documentation" title="Perm
 
 </dd></dl>
 
+<dl class="py function">
+<dt class="sig sig-object py" id="pytest_container.container.container_and_marks_from_pytest_param">
+<span class="sig-prename descclassname"><span class="pre">pytest_container.container.</span></span><span class="sig-name descname"><span class="pre">container_and_marks_from_pytest_param</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">param</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pytest_container.container.Container" title="pytest_container.container.Container"><span class="pre">Container</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><span class="pre">Tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pytest_container.container.Container" title="pytest_container.container.Container"><span class="pre">Container</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Literal" title="(in Python v3.12)"><span class="pre">Literal</span></a><span class="p"><span class="pre">[</span></span><span class="pre">None</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pytest_container.container.container_and_marks_from_pytest_param" title="Permalink to this definition">¶</a></dt>
+<dt class="sig sig-object py">
+<span class="sig-prename descclassname"><span class="pre">pytest_container.container.</span></span><span class="sig-name descname"><span class="pre">container_and_marks_from_pytest_param</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">param</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pytest_container.container.DerivedContainer" title="pytest_container.container.DerivedContainer"><span class="pre">DerivedContainer</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><span class="pre">Tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pytest_container.container.DerivedContainer" title="pytest_container.container.DerivedContainer"><span class="pre">DerivedContainer</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Literal" title="(in Python v3.12)"><span class="pre">Literal</span></a><span class="p"><span class="pre">[</span></span><span class="pre">None</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span></dt>
+<dt class="sig sig-object py">
+<span class="sig-prename descclassname"><span class="pre">pytest_container.container.</span></span><span class="sig-name descname"><span class="pre">container_and_marks_from_pytest_param</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">param</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ParameterSet</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><span class="pre">Tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.12)"><span class="pre">Union</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pytest_container.container.Container" title="pytest_container.container.Container"><span class="pre">Container</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#pytest_container.container.DerivedContainer" title="pytest_container.container.DerivedContainer"><span class="pre">DerivedContainer</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.12)"><span class="pre">Optional</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Collection" title="(in Python v3.12)"><span class="pre">Collection</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.12)"><span class="pre">Union</span></a><span class="p"><span class="pre">[</span></span><span class="pre">MarkDecorator</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Mark</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span></dt>
+<dd><p>Extracts the <a class="reference internal" href="#pytest_container.container.Container" title="pytest_container.container.Container"><code class="xref py py-class docutils literal notranslate"><span class="pre">Container</span></code></a> or
+<a class="reference internal" href="#pytest_container.container.DerivedContainer" title="pytest_container.container.DerivedContainer"><code class="xref py py-class docutils literal notranslate"><span class="pre">DerivedContainer</span></code></a> and the
+corresponding marks from a <a class="reference external" href="https://docs.pytest.org/en/stable/reference.html?#pytest.param">pytest.param</a> and
+returns both.</p>
+<p>If <code class="docutils literal notranslate"><span class="pre">param</span></code> is either a <a class="reference internal" href="#pytest_container.container.Container" title="pytest_container.container.Container"><code class="xref py py-class docutils literal notranslate"><span class="pre">Container</span></code></a>
+or a <a class="reference internal" href="#pytest_container.container.DerivedContainer" title="pytest_container.container.DerivedContainer"><code class="xref py py-class docutils literal notranslate"><span class="pre">DerivedContainer</span></code></a>, then param is
+returned directly and the second return value is <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>
+</dd></dl>
+
 <dl class="py function">
 <dt class="sig sig-object py" id="pytest_container.container.container_from_pytest_param">
 <span class="sig-prename descclassname"><span class="pre">pytest_container.container.</span></span><span class="sig-name descname"><span class="pre">container_from_pytest_param</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">param</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.12)"><span class="pre">Union</span></a><span class="p"><span class="pre">[</span></span><span class="pre">ParameterSet</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#pytest_container.container.Container" title="pytest_container.container.Container"><span class="pre">Container</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#pytest_container.container.DerivedContainer" title="pytest_container.container.DerivedContainer"><span class="pre">DerivedContainer</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.12)"><span class="pre">Union</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pytest_container.container.Container" title="pytest_container.container.Container"><span class="pre">Container</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#pytest_container.container.DerivedContainer" title="pytest_container.container.DerivedContainer"><span class="pre">DerivedContainer</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pytest_container.container.container_from_pytest_param" title="Permalink to this definition">¶</a></dt>

changelog.html

@@ -40,6 +40,12 @@ <h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this he
 <section id="next-release">
 <h2>Next Release<a class="headerlink" href="#next-release" title="Permalink to this heading">¶</a></h2>
 <p>Breaking changes:</p>
+<ul class="simple">
+<li><p>deprecate the function <code class="docutils literal notranslate"><span class="pre">pytest_container.container_from_pytest_param</span></code>,
+please use
+<a class="reference internal" href="api.html#pytest_container.container.container_and_marks_from_pytest_param" title="pytest_container.container.container_and_marks_from_pytest_param"><code class="xref py py-func docutils literal notranslate"><span class="pre">container_and_marks_from_pytest_param()</span></code></a>
+instead.</p></li>
+</ul>
 <p>Improvements and new features:</p>
 <p>Documentation:</p>
 <p>Internal changes:</p>

genindex.html

@@ -141,6 +141,8 @@ <h2 id="C">C</h2>
 </li>
       </ul></li>
       <li><a href="api.html#pytest_container.plugin.container">container() (in module pytest_container.plugin)</a>
+</li>
+      <li><a href="api.html#pytest_container.container.container_and_marks_from_pytest_param">container_and_marks_from_pytest_param() (in module pytest_container.container)</a>
 </li>
       <li><a href="api.html#pytest_container.container.ContainerLauncher.container_data">container_data (pytest_container.container.ContainerLauncher property)</a>
 
@@ -164,14 +166,14 @@ <h2 id="C">C</h2>
 </li>
       <li><a href="api.html#pytest_container.inspect.PortForwarding.container_port">container_port (pytest_container.inspect.PortForwarding attribute)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api.html#pytest_container.container.ContainerLauncher.container_runtime">container_runtime (pytest_container.container.ContainerLauncher attribute)</a>
 
       <ul>
         <li><a href="api.html#pytest_container.container.VolumeCreator.container_runtime">(pytest_container.container.VolumeCreator attribute)</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api.html#pytest_container.plugin.container_runtime">container_runtime() (in module pytest_container.plugin)</a>
 </li>
       <li><a href="api.html#pytest_container.container.container_to_pytest_param">container_to_pytest_param() (in module pytest_container.container)</a>