Deployed 9f9b1f7 to dev with MkDocs 1.6.1 and mike 2.1.3

This commit is contained in:
github-actions 2025-04-07 13:08:48 +00:00
parent ca8d66e100
commit a0cb85afde
5 changed files with 6 additions and 6 deletions

File diff suppressed because one or more lines are too long

View file

@ -13,7 +13,7 @@
<a id=__codelineno-0-13 name=__codelineno-0-13 href=#__codelineno-0-13></a> <span class=p>]</span> <span class=o>=</span> <span class=kc>None</span><span class=p>,</span> <a id=__codelineno-0-13 name=__codelineno-0-13 href=#__codelineno-0-13></a> <span class=p>]</span> <span class=o>=</span> <span class=kc>None</span><span class=p>,</span>
<a id=__codelineno-0-14 name=__codelineno-0-14 href=#__codelineno-0-14></a> <span class=n>gc_collect</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=o>=</span> <span class=kc>True</span><span class=p>,</span> <a id=__codelineno-0-14 name=__codelineno-0-14 href=#__codelineno-0-14></a> <span class=n>gc_collect</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=o>=</span> <span class=kc>True</span><span class=p>,</span>
<a id=__codelineno-0-15 name=__codelineno-0-15 href=#__codelineno-0-15></a><span class=p>)</span> <span class=o>-&gt;</span> <span class=n><a class="autorefs autorefs-external" title=typing.Callable href=https://docs.python.org/3.12/library/typing.html#typing.Callable>Callable</a></span> <a id=__codelineno-0-15 name=__codelineno-0-15 href=#__codelineno-0-15></a><span class=p>)</span> <span class=o>-&gt;</span> <span class=n><a class="autorefs autorefs-external" title=typing.Callable href=https://docs.python.org/3.12/library/typing.html#typing.Callable>Callable</a></span>
</code></pre></div> <div class="doc doc-contents first"> <p><a href=https://github.com/django-components/django-components/tree/master/src/django_components/util/testing.py#L78 target=_blank>See source code</a></p> <p>Decorator for testing components from django-components.</p> <p><code>@djc_test</code> manages the global state of django-components, ensuring that each test is properly isolated and that components registered in one test do not affect other tests.</p> <p>This decorator can be applied to a function, method, or a class. If applied to a class, it will search for all methods that start with <code>test_</code>, and apply the decorator to them. This is applied recursively to nested classes as well.</p> <p>Examples:</p> <p>Applying to a function: <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.testing</span><span class=w> </span><span class=kn>import</span> <span class=n>djc_test</span> </code></pre></div> <div class="doc doc-contents first"> <p><a href=https://github.com/django-components/django-components/tree/master/src/django_components/util/testing.py#L79 target=_blank>See source code</a></p> <p>Decorator for testing components from django-components.</p> <p><code>@djc_test</code> manages the global state of django-components, ensuring that each test is properly isolated and that components registered in one test do not affect other tests.</p> <p>This decorator can be applied to a function, method, or a class. If applied to a class, it will search for all methods that start with <code>test_</code>, and apply the decorator to them. This is applied recursively to nested classes as well.</p> <p>Examples:</p> <p>Applying to a function: <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.testing</span><span class=w> </span><span class=kn>import</span> <span class=n>djc_test</span>
<a id=__codelineno-0-2 name=__codelineno-0-2 href=#__codelineno-0-2></a> <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=nd>@djc_test</span> <a id=__codelineno-0-3 name=__codelineno-0-3 href=#__codelineno-0-3></a><span class=nd>@djc_test</span>
<a id=__codelineno-0-4 name=__codelineno-0-4 href=#__codelineno-0-4></a><span class=k>def</span><span class=w> </span><span class=nf>test_my_component</span><span class=p>():</span> <a id=__codelineno-0-4 name=__codelineno-0-4 href=#__codelineno-0-4></a><span class=k>def</span><span class=w> </span><span class=nf>test_my_component</span><span class=p>():</span>

View file

@ -5,7 +5,7 @@
</code></pre></div> <p>Then, to get the URL for the component, use <code>get_component_url()</code>:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-1-1 name=__codelineno-1-1 href=#__codelineno-1-1></a><span class=kn>from</span><span class=w> </span><span class=nn>django_components</span><span class=w> </span><span class=kn>import</span> <span class=n>get_component_url</span> </code></pre></div> <p>Then, to get the URL for the component, use <code>get_component_url()</code>:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-1-1 name=__codelineno-1-1 href=#__codelineno-1-1></a><span class=kn>from</span><span class=w> </span><span class=nn>django_components</span><span class=w> </span><span class=kn>import</span> <span class=n>get_component_url</span>
<a id=__codelineno-1-2 name=__codelineno-1-2 href=#__codelineno-1-2></a> <a id=__codelineno-1-2 name=__codelineno-1-2 href=#__codelineno-1-2></a>
<a id=__codelineno-1-3 name=__codelineno-1-3 href=#__codelineno-1-3></a><span class=n>url</span> <span class=o>=</span> <span class=n>get_component_url</span><span class=p>(</span><span class=n>MyComponent</span><span class=p>)</span> <a id=__codelineno-1-3 name=__codelineno-1-3 href=#__codelineno-1-3></a><span class=n>url</span> <span class=o>=</span> <span class=n>get_component_url</span><span class=p>(</span><span class=n>MyComponent</span><span class=p>)</span>
</code></pre></div> <p>This way you don't have to mix your app URLs with component URLs.</p> <p>Read more on <a href=https://django-components.github.io/django-components/0.135/concepts/fundamentals/component_views_urls/ >Component views and URLs</a>.</p> </li> </ul> <h4 id=deprecation>Deprecation<a class=headerlink href=#deprecation title="Permanent link">¤</a></h4> <ul> <li> <p>Currently, view request handlers such as <code>get()</code> and <code>post()</code> methods can be defined directly on the <code>Component</code> class:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-2-1 name=__codelineno-2-1 href=#__codelineno-2-1></a><span class=k>class</span><span class=w> </span><span class=nc>MyComponent</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span> </code></pre></div> <p>This way you don't have to mix your app URLs with component URLs.</p> <p>Read more on <a href=https://django-components.github.io/django-components/0.135/concepts/fundamentals/component_views_urls/ >Component views and URLs</a>.</p> </li> <li> <p><code>@djc_test</code> can now be called without first calling <code>django.setup()</code>, in which case it does it for you.</p> </li> </ul> <h4 id=deprecation>Deprecation<a class=headerlink href=#deprecation title="Permanent link">¤</a></h4> <ul> <li> <p>Currently, view request handlers such as <code>get()</code> and <code>post()</code> methods can be defined directly on the <code>Component</code> class:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-2-1 name=__codelineno-2-1 href=#__codelineno-2-1></a><span class=k>class</span><span class=w> </span><span class=nc>MyComponent</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
<a id=__codelineno-2-2 name=__codelineno-2-2 href=#__codelineno-2-2></a> <span class=k>def</span><span class=w> </span><span class=nf>get</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>request</span><span class=p>):</span> <a id=__codelineno-2-2 name=__codelineno-2-2 href=#__codelineno-2-2></a> <span class=k>def</span><span class=w> </span><span class=nf>get</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>request</span><span class=p>):</span>
<a id=__codelineno-2-3 name=__codelineno-2-3 href=#__codelineno-2-3></a> <span class=k>return</span> <span class=bp>self</span><span class=o>.</span><span class=n>render_to_response</span><span class=p>()</span> <a id=__codelineno-2-3 name=__codelineno-2-3 href=#__codelineno-2-3></a> <span class=k>return</span> <span class=bp>self</span><span class=o>.</span><span class=n>render_to_response</span><span class=p>()</span>
</code></pre></div> <p>Or, nested within the <code>Component.View</code> class:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-3-1 name=__codelineno-3-1 href=#__codelineno-3-1></a><span class=k>class</span><span class=w> </span><span class=nc>MyComponent</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span> </code></pre></div> <p>Or, nested within the <code>Component.View</code> class:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-3-1 name=__codelineno-3-1 href=#__codelineno-3-1></a><span class=k>class</span><span class=w> </span><span class=nc>MyComponent</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>

File diff suppressed because one or more lines are too long

View file

@ -1,7 +1,7 @@
[ [
{ {
"version": "dev", "version": "dev",
"title": "dev (bb5de86)", "title": "dev (9f9b1f7)",
"aliases": [] "aliases": []
}, },
{ {