Deployed ccf02fa to dev with MkDocs 1.6.1 and mike 2.1.3

dev/reference/extension_commands/index.html

@@ -354,7 +354,7 @@
 </code></pre></div> <div class="doc doc-contents "> <p><a href=https://github.com/django-components/django-components/tree/master/src/django_components/util/command.py#L151 target=_blank>See source code</a></p> <p>Usage information that will be displayed with sub-command help, by default the name of the program and any positional arguments before the subparser argument.</p> </div> </div> <div class="doc doc-object doc-attribute"> <h4 id=django_components.CommandSubcommand.required class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">required</span> <span class="doc doc-labels"> <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small> <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small> </span> <a href=#django_components.CommandSubcommand.required class=headerlink title="Permanent link">¤</a></h4> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>required</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/functions.html#bool>bool</a></span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span>
 </code></pre></div> <div class="doc doc-contents "> <p><a href=https://github.com/django-components/django-components/tree/master/src/django_components/util/command.py#L170 target=_blank>See source code</a></p> <p>Whether or not a subcommand must be provided, by default <code>False</code> (added in 3.7)</p> </div> </div> <div class="doc doc-object doc-attribute"> <h4 id=django_components.CommandSubcommand.title class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">title</span> <span class="doc doc-labels"> <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small> <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small> </span> <a href=#django_components.CommandSubcommand.title class=headerlink title="Permanent link">¤</a></h4> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>title</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span>
 </code></pre></div> <div class="doc doc-contents "> <p><a href=https://github.com/django-components/django-components/tree/master/src/django_components/util/command.py#L142 target=_blank>See source code</a></p> <p>Title for the sub-parser group in help output; by default “subcommands” if description is provided, otherwise uses title for positional arguments.</p> </div> </div> <div class="doc doc-object doc-function"> <h4 id=django_components.CommandSubcommand.asdict class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">asdict</span> <a href=#django_components.CommandSubcommand.asdict class=headerlink title="Permanent link">¤</a></h4> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=nf>asdict</span><span class=p>()</span> <span class=o>-&gt;</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#dict>dict</a></span>
-</code></pre></div> <div class="doc doc-contents "> <p><a href=https://github.com/django-components/django-components/tree/master/src/django_components/util/command.py#L184 target=_blank>See source code</a></p> <p>Convert the dataclass to a dictionary, stripping out fields with <code>None</code> values</p> </div> </div> </div> </div> </div> <div class="doc doc-object doc-class"> <h3 id=django_components.ComponentCommand class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">ComponentCommand</span> <a href=#django_components.ComponentCommand class=headerlink title="Permanent link">¤</a></h3> <div class="doc doc-contents first"> <p class="doc doc-class-bases">Bases: <code>object</code></p> <p><a href=https://github.com/django-components/django-components/tree/master/src/django_components/util/command.py#L240 target=_blank>See source code</a></p> <p>Definition of a CLI command.</p> <p>This class is based on Python's <a href=https://docs.python.org/3/library/argparse.html><code>argparse</code></a> module and Django's <a href=https://docs.djangoproject.com/en/5.1/howto/custom-management-commands/ ><code>BaseCommand</code></a> class. <code>ComponentCommand</code> allows you to define:</p> <ul> <li>Command name, description, and help text</li> <li>Arguments and options (e.g. <code>--name John</code>)</li> <li>Group arguments (see <a href=https://docs.python.org/3/library/argparse.html#argument-groups>argparse groups</a>)</li> <li>Subcommands (e.g. <code>components ext run my_ext hello</code>)</li> <li>Handler behavior</li> </ul> <p>Each extension can add its own commands, which will be available to run with <code>components ext run</code>.</p> <p>Extensions use the <code>ComponentCommand</code> class to define their commands.</p> <p>For example, if you define and install the following extension:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=kn>from</span><span class=w> </span><span class=nn>django_components</span> <span class=n>ComponentCommand</span><span class=p>,</span> <span class=n>ComponentExtension</span>
+</code></pre></div> <div class="doc doc-contents "> <p><a href=https://github.com/django-components/django-components/tree/master/src/django_components/util/command.py#L184 target=_blank>See source code</a></p> <p>Convert the dataclass to a dictionary, stripping out fields with <code>None</code> values</p> </div> </div> </div> </div> </div> <div class="doc doc-object doc-class"> <h3 id=django_components.ComponentCommand class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">ComponentCommand</span> <a href=#django_components.ComponentCommand class=headerlink title="Permanent link">¤</a></h3> <div class="doc doc-contents first"> <p class="doc doc-class-bases">Bases: <code>object</code></p> <p><a href=https://github.com/django-components/django-components/tree/master/src/django_components/util/command.py#L240 target=_blank>See source code</a></p> <p>Definition of a CLI command.</p> <p>This class is based on Python's <a href=https://docs.python.org/3/library/argparse.html><code>argparse</code></a> module and Django's <a href=https://docs.djangoproject.com/en/5.2/howto/custom-management-commands/ ><code>BaseCommand</code></a> class. <code>ComponentCommand</code> allows you to define:</p> <ul> <li>Command name, description, and help text</li> <li>Arguments and options (e.g. <code>--name John</code>)</li> <li>Group arguments (see <a href=https://docs.python.org/3/library/argparse.html#argument-groups>argparse groups</a>)</li> <li>Subcommands (e.g. <code>components ext run my_ext hello</code>)</li> <li>Handler behavior</li> </ul> <p>Each extension can add its own commands, which will be available to run with <code>components ext run</code>.</p> <p>Extensions use the <code>ComponentCommand</code> class to define their commands.</p> <p>For example, if you define and install the following extension:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=kn>from</span><span class=w> </span><span class=nn>django_components</span> <span class=n>ComponentCommand</span><span class=p>,</span> <span class=n>ComponentExtension</span>
 <a id=__codelineno-0-2 name=__codelineno-0-2 href=#__codelineno-0-2></a>
 <a id=__codelineno-0-3 name=__codelineno-0-3 href=#__codelineno-0-3></a><span class=k>class</span><span class=w> </span><span class=nc>HelloCommand</span><span class=p>(</span><span class=n>ComponentCommand</span><span class=p>):</span>
 <a id=__codelineno-0-4 name=__codelineno-0-4 href=#__codelineno-0-4></a>    <span class=n>name</span> <span class=o>=</span> <span class=s2>&quot;hello&quot;</span>