nautobot 2.3.15b1__py3-none-any.whl → 2.4.0__py3-none-any.whl

nautobot/project-static/docs/user-guide/platform-functionality/template-filters.html

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.49">
     
     
       
@@ -2117,6 +2117,27 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../feature-guides/wireless-networks-and-controllers.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Wireless Networks and Controllers
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -3949,6 +3970,27 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../core-data-model/dcim/virtualdevicecontext.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Virtual Device Context
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -4561,6 +4603,123 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    
+    
+    
+      
+      
+    
+    
+    <li class="md-nav__item md-nav__item--nested">
+      
+        
+        
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3_9" >
+        
+          
+          
+          <div class="md-nav__link md-nav__container">
+            <a href="../core-data-model/wireless/index.html" class="md-nav__link ">
+              
+  
+  <span class="md-ellipsis">
+    Wireless
+  </span>
+  
+
+            </a>
+            
+              
+              <label class="md-nav__link " for="__nav_2_3_9" id="__nav_2_3_9_label" tabindex="0">
+                <span class="md-nav__icon md-icon"></span>
+              </label>
+            
+          </div>
+        
+        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_3_9_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_3_9">
+            <span class="md-nav__icon md-icon"></span>
+            Wireless
+          </label>
+          <ul class="md-nav__list" data-md-scrollfix>
+            
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../core-data-model/wireless/supporteddatarate.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Supported Data Rate
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../core-data-model/wireless/radioprofile.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Radio Profile
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../core-data-model/wireless/wirelessnetwork.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Wireless Network
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+          </ul>
+        </nav>
+      
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -4774,6 +4933,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="events.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Event Notifications
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="exporttemplate.html" class="md-nav__link">
         
@@ -4848,7 +5028,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_9" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_10" >
         
           
           
@@ -4864,14 +5044,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_2_4_9" id="__nav_2_4_9_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_2_4_10" id="__nav_2_4_10_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_9_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_4_9">
+        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_10_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_4_10">
             <span class="md-nav__icon md-icon"></span>
             GraphQL
           </label>
@@ -4944,7 +5124,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_11" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_12" >
         
           
           
@@ -4960,14 +5140,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_2_4_11" id="__nav_2_4_11_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_2_4_12" id="__nav_2_4_12_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_11_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_4_11">
+        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_12_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_4_12">
             <span class="md-nav__icon md-icon"></span>
             Jobs
           </label>
@@ -4979,6 +5159,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="jobs/kubernetes-job-support.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Kubernetes Job Support
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="jobs/jobbutton.html" class="md-nav__link">
         
@@ -5042,6 +5243,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="jobs/jobqueue.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Job Queues
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="jobs/job-scheduling-and-approvals.html" class="md-nav__link">
         
@@ -5155,6 +5377,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="rendering-jinja-templates.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Rendering Jinja Templates
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     
     
     
@@ -5166,7 +5409,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_16" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_18" >
         
           
           
@@ -5182,14 +5425,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_2_4_16" id="__nav_2_4_16_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_2_4_18" id="__nav_2_4_18_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_16_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_4_16">
+        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_18_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_4_18">
             <span class="md-nav__icon md-icon"></span>
             REST API
           </label>
@@ -5602,6 +5845,15 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#pre_tag" class="md-nav__link">
+    <span class="md-ellipsis">
+      pre_tag
+    </span>
+  </a>
+  
 </li>
         
           <li class="md-nav__item">
@@ -5758,10 +6010,10 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_23" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_25" >
         
           
-          <label class="md-nav__link" for="__nav_2_4_23" id="__nav_2_4_23_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_2_4_25" id="__nav_2_4_25_label" tabindex="0">
             
   
   <span class="md-ellipsis">
@@ -5772,8 +6024,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
         
-        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_23_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_4_23">
+        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_25_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_4_25">
             <span class="md-nav__icon md-icon"></span>
             Users
           </label>
@@ -7178,6 +7430,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../code-reference/nautobot/apps/events.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    nautobot.apps.events
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../code-reference/nautobot/apps/exceptions.html" class="md-nav__link">
         
@@ -7726,6 +7999,123 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    
+    
+    
+      
+      
+    
+    
+    <li class="md-nav__item md-nav__item--nested">
+      
+        
+        
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2_9_5" >
+        
+          
+          
+          <div class="md-nav__link md-nav__container">
+            <a href="../../development/apps/migration/ui-component-framework/index.html" class="md-nav__link ">
+              
+  
+  <span class="md-ellipsis">
+    UI Component Framework
+  </span>
+  
+
+            </a>
+            
+              
+              <label class="md-nav__link " for="__nav_3_2_9_5" id="__nav_3_2_9_5_label" tabindex="0">
+                <span class="md-nav__icon md-icon"></span>
+              </label>
+            
+          </div>
+        
+        <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_3_2_9_5_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_3_2_9_5">
+            <span class="md-nav__icon md-icon"></span>
+            UI Component Framework
+          </label>
+          <ul class="md-nav__list" data-md-scrollfix>
+            
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../development/apps/migration/ui-component-framework/migration-steps.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Migration steps
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../development/apps/migration/ui-component-framework/custom-content.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Custom content
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../development/apps/migration/ui-component-framework/best-practices.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Best practices
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+          </ul>
+        </nav>
+      
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -8071,6 +8461,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../development/core/minikube-dev-environment-for-k8s-jobs.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Minikube Dev Environment for K8s Jobs
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../development/core/model-checklist.html" class="md-nav__link">
         
@@ -8260,6 +8671,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../development/core/ui-component-framework.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    UI Component Framework
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../development/core/release-checklist.html" class="md-nav__link">
         
@@ -8342,6 +8774,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../release-notes/version-2.4.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Version 2.4
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../release-notes/version-2.3.html" class="md-nav__link">
         
@@ -9108,6 +9561,15 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#pre_tag" class="md-nav__link">
+    <span class="md-ellipsis">
+      pre_tag
+    </span>
+  </a>
+  
 </li>
         
           <li class="md-nav__item">
@@ -9391,12 +9853,18 @@ additionally if there is an <code>object.description</code> this will be used as
 <p>Render a muted placeholder (<code>&lt;span class="text-muted"&gt;&amp;mdash;&lt;/span&gt;</code>) if value is falsey, else render the provided value.</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a><span class="cp">{{</span> <span class="nv">html</span> <span class="o">|</span> <span class="nf">placeholder</span> <span class="cp">}}</span>
 </code></pre></div>
+<h3 id="pre_tag">pre_tag<a class="headerlink" href="#pre_tag" title="Permanent link">&para;</a></h3>
+<p>Render a value within <code>&lt;pre&gt;&lt;/pre&gt;</code> tags to enable formatting.</p>
+<div class="highlight"><span class="filename">template.html</span><pre><span></span><code><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a><span class="cp">{{</span> <span class="nv">some_html</span> <span class="o">|</span> <span class="nf">pre_tag</span> <span class="cp">}}</span>
+</code></pre></div>
+<div class="highlight"><span class="filename">script.py</span><pre><span></span><code><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a><span class="x">pre_tag(some_html)</span>
+</code></pre></div>
 <h3 id="render_boolean">render_boolean<a class="headerlink" href="#render_boolean" title="Permanent link">&para;</a></h3>
 <p>Render HTML from a computed boolean value.</p>
 <p>If value is (for example) a non-empty string or True or a non-zero number, this renders <code>&lt;span class="text-success"&gt;&lt;i class="mdi mdi-check-bold" title="Yes"&gt;&lt;/i&gt;&lt;/span&gt;</code></p>
 <p>If value is (for example) "" or 0 or False, this renders <code>&lt;span class="text-danger"&gt;&lt;i class="mdi mdi-close-thick" title="No"&gt;&lt;/i&gt;&lt;/span&gt;</code></p>
 <p>If value is None this renders <code>&lt;span class="text-muted"&gt;&amp;mdash;&lt;/span&gt;</code></p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a><span class="cp">{{</span> <span class="nv">value</span> <span class="o">|</span> <span class="nf">render_boolean</span> <span class="cp">}}</span>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-18-1" name="__codelineno-18-1" href="#__codelineno-18-1"></a><span class="cp">{{</span> <span class="nv">value</span> <span class="o">|</span> <span class="nf">render_boolean</span> <span class="cp">}}</span>
 </code></pre></div>
 <h3 id="render_json">render_json<a class="headerlink" href="#render_json" title="Permanent link">&para;</a></h3>
 <p>Render a dictionary as formatted JSON.</p>
@@ -9404,11 +9872,18 @@ additionally if there is an <code>object.description</code> this will be used as
 <summary>Changed in version 2.2.0</summary>
 <p>Unless <code>syntax_highlight=False</code> is specified, the returned string will be wrapped in a <code>&lt;code class="language-json&gt;</code> HTML tag to flag it for syntax highlighting by highlight.js.</p>
 </details>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a><span class="cp">{{</span> <span class="nv">data</span> <span class="o">|</span> <span class="nf">render_json</span> <span class="cp">}}</span>
+<details class="version-added">
+<summary>Added in version 2.3.0</summary>
+<p>Added option for pretty print the output: <code>pretty_print=False</code>, default is False. If True the output will be wrapped in <code>&lt;pre&gt;</code> tags.</p>
+</details>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a><span class="cp">{{</span> <span class="nv">data</span> <span class="o">|</span> <span class="nf">render_json</span> <span class="cp">}}</span>
+<a id="__codelineno-19-2" name="__codelineno-19-2" href="#__codelineno-19-2"></a><span class="cp">{{</span> <span class="nv">data</span> <span class="o">|</span> <span class="nf">render_json</span><span class="o">:</span><span class="kp">False</span> <span class="cp">}}</span><span class="x"> &lt;!-- without syntax highlitning -&gt;&gt;</span>
+</code></pre></div>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-20-1" name="__codelineno-20-1" href="#__codelineno-20-1"></a><span class="x">json_pretty_printed = render_json(data, pretty_print=True)</span>
 </code></pre></div>
 <h3 id="render_markdown">render_markdown<a class="headerlink" href="#render_markdown" title="Permanent link">&para;</a></h3>
 <p>Render and sanitize Markdown text into HTML. A limited subset of HTML tags and attributes are permitted in the text as well; non-permitted HTML will be stripped from the output for security.</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-18-1" name="__codelineno-18-1" href="#__codelineno-18-1"></a><span class="cp">{{</span> <span class="nv">text</span> <span class="o">|</span> <span class="nf">render_markdown</span> <span class="cp">}}</span>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-21-1" name="__codelineno-21-1" href="#__codelineno-21-1"></a><span class="cp">{{</span> <span class="nv">text</span> <span class="o">|</span> <span class="nf">render_markdown</span> <span class="cp">}}</span>
 </code></pre></div>
 <h4 id="permitted-html-tags-and-attributes">Permitted HTML Tags and Attributes<a class="headerlink" href="#permitted-html-tags-and-attributes" title="Permanent link">&para;</a></h4>
 <details class="version-added">
@@ -9689,7 +10164,7 @@ additionally if there is an <code>object.description</code> this will be used as
     1024768 =&gt; "11 days 20 hours 39 minutes"
     1 =&gt; "0 days 0 hours 0 minutes"
     3660 =&gt; "0 days 1 hour 1 minute"</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a><span class="cp">{{</span> <span class="m">1024768</span> <span class="o">|</span> <span class="nf">render_uptime</span> <span class="cp">}}</span>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-22-1" name="__codelineno-22-1" href="#__codelineno-22-1"></a><span class="cp">{{</span> <span class="m">1024768</span> <span class="o">|</span> <span class="nf">render_uptime</span> <span class="cp">}}</span>
 </code></pre></div>
 <h3 id="render_yaml">render_yaml<a class="headerlink" href="#render_yaml" title="Permanent link">&para;</a></h3>
 <p>Render a dictionary as formatted YAML.</p>
@@ -9697,65 +10172,65 @@ additionally if there is an <code>object.description</code> this will be used as
 <summary>Changed in version 2.2.0</summary>
 <p>Unless <code>syntax_highlight=False</code> is specified, the returned string will be wrapped in a <code>&lt;code class="language-yaml&gt;</code> HTML tag to flag it for syntax highlighting by highlight.js.</p>
 </details>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-20-1" name="__codelineno-20-1" href="#__codelineno-20-1"></a><span class="cp">{{</span> <span class="nv">data</span> <span class="o">|</span> <span class="nf">render_yaml</span> <span class="cp">}}</span>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-23-1" name="__codelineno-23-1" href="#__codelineno-23-1"></a><span class="cp">{{</span> <span class="nv">data</span> <span class="o">|</span> <span class="nf">render_yaml</span> <span class="cp">}}</span>
 </code></pre></div>
 <h3 id="settings_or_config">settings_or_config<a class="headerlink" href="#settings_or_config" title="Permanent link">&para;</a></h3>
 <p>Get a value from Django settings (if specified) or Constance configuration (otherwise).</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-21-1" name="__codelineno-21-1" href="#__codelineno-21-1"></a><span class="cp">{{</span> <span class="s2">&quot;RELEASE_CHECK_URL&quot;</span> <span class="o">|</span> <span class="nf">settings_or_config</span> <span class="cp">}}</span>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-24-1" name="__codelineno-24-1" href="#__codelineno-24-1"></a><span class="cp">{{</span> <span class="s2">&quot;RELEASE_CHECK_URL&quot;</span> <span class="o">|</span> <span class="nf">settings_or_config</span> <span class="cp">}}</span>
 </code></pre></div>
 <details class="version-added">
 <summary>Added in version 2.0.0</summary>
 <p>This filter now accepts an optional <code>app_name</code> parameter, which allows you to use this filter for Third-Party Nautobot Apps.</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-22-1" name="__codelineno-22-1" href="#__codelineno-22-1"></a><span class="x"># Django Template</span>
-<a id="__codelineno-22-2" name="__codelineno-22-2" href="#__codelineno-22-2"></a><span class="cp">{{</span> <span class="s2">&quot;SAMPLE_VARIABLE&quot;</span> <span class="o">|</span> <span class="nf">settings_or_config</span><span class="s2">:&quot;example_app&quot;</span> <span class="cp">}}</span>
-<a id="__codelineno-22-3" name="__codelineno-22-3" href="#__codelineno-22-3"></a><span class="cp">{{</span> <span class="s2">&quot;lowercase_example&quot;</span> <span class="o">|</span> <span class="nf">settings_or_config</span><span class="s2">:&quot;example_app&quot;</span> <span class="cp">}}</span>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-25-1" name="__codelineno-25-1" href="#__codelineno-25-1"></a><span class="x"># Django Template</span>
+<a id="__codelineno-25-2" name="__codelineno-25-2" href="#__codelineno-25-2"></a><span class="cp">{{</span> <span class="s2">&quot;SAMPLE_VARIABLE&quot;</span> <span class="o">|</span> <span class="nf">settings_or_config</span><span class="s2">:&quot;example_app&quot;</span> <span class="cp">}}</span>
+<a id="__codelineno-25-3" name="__codelineno-25-3" href="#__codelineno-25-3"></a><span class="cp">{{</span> <span class="s2">&quot;lowercase_example&quot;</span> <span class="o">|</span> <span class="nf">settings_or_config</span><span class="s2">:&quot;example_app&quot;</span> <span class="cp">}}</span>
 </code></pre></div>
 </details>
 <h3 id="slugify">slugify<a class="headerlink" href="#slugify" title="Permanent link">&para;</a></h3>
 <p>Slugify a string.</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-23-1" name="__codelineno-23-1" href="#__codelineno-23-1"></a><span class="x"># Django Template</span>
-<a id="__codelineno-23-2" name="__codelineno-23-2" href="#__codelineno-23-2"></a><span class="cp">{{</span> <span class="nv">string</span> <span class="o">|</span> <span class="nf">slugify</span> <span class="cp">}}</span>
-<a id="__codelineno-23-3" name="__codelineno-23-3" href="#__codelineno-23-3"></a>
-<a id="__codelineno-23-4" name="__codelineno-23-4" href="#__codelineno-23-4"></a><span class="x"># Jinja</span>
-<a id="__codelineno-23-5" name="__codelineno-23-5" href="#__codelineno-23-5"></a><span class="cp">{{</span> <span class="nv">string</span> <span class="o">|</span> <span class="nf">slugify</span> <span class="cp">}}</span>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-26-1" name="__codelineno-26-1" href="#__codelineno-26-1"></a><span class="x"># Django Template</span>
+<a id="__codelineno-26-2" name="__codelineno-26-2" href="#__codelineno-26-2"></a><span class="cp">{{</span> <span class="nv">string</span> <span class="o">|</span> <span class="nf">slugify</span> <span class="cp">}}</span>
+<a id="__codelineno-26-3" name="__codelineno-26-3" href="#__codelineno-26-3"></a>
+<a id="__codelineno-26-4" name="__codelineno-26-4" href="#__codelineno-26-4"></a><span class="x"># Jinja</span>
+<a id="__codelineno-26-5" name="__codelineno-26-5" href="#__codelineno-26-5"></a><span class="cp">{{</span> <span class="nv">string</span> <span class="o">|</span> <span class="nf">slugify</span> <span class="cp">}}</span>
 </code></pre></div>
 <h3 id="split">split<a class="headerlink" href="#split" title="Permanent link">&para;</a></h3>
 <p>Split a string by the given value (default: comma)</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-24-1" name="__codelineno-24-1" href="#__codelineno-24-1"></a><span class="x"># Django Template</span>
-<a id="__codelineno-24-2" name="__codelineno-24-2" href="#__codelineno-24-2"></a><span class="cp">{{</span> <span class="nv">string</span> <span class="o">|</span> <span class="nf">split</span> <span class="cp">}}</span>
-<a id="__codelineno-24-3" name="__codelineno-24-3" href="#__codelineno-24-3"></a><span class="cp">{{</span> <span class="nv">string</span> <span class="o">|</span> <span class="nf">split</span><span class="s1">:&#39;;&#39;</span> <span class="cp">}}</span>
-<a id="__codelineno-24-4" name="__codelineno-24-4" href="#__codelineno-24-4"></a>
-<a id="__codelineno-24-5" name="__codelineno-24-5" href="#__codelineno-24-5"></a><span class="x"># Jinja</span>
-<a id="__codelineno-24-6" name="__codelineno-24-6" href="#__codelineno-24-6"></a><span class="cp">{{</span> <span class="nv">string</span> <span class="o">|</span> <span class="nf">split</span> <span class="cp">}}</span>
-<a id="__codelineno-24-7" name="__codelineno-24-7" href="#__codelineno-24-7"></a><span class="cp">{{</span> <span class="nv">string</span> <span class="o">|</span> <span class="nf">split</span><span class="o">(</span><span class="s1">&#39;;&#39;</span><span class="o">)</span> <span class="cp">}}</span>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-27-1" name="__codelineno-27-1" href="#__codelineno-27-1"></a><span class="x"># Django Template</span>
+<a id="__codelineno-27-2" name="__codelineno-27-2" href="#__codelineno-27-2"></a><span class="cp">{{</span> <span class="nv">string</span> <span class="o">|</span> <span class="nf">split</span> <span class="cp">}}</span>
+<a id="__codelineno-27-3" name="__codelineno-27-3" href="#__codelineno-27-3"></a><span class="cp">{{</span> <span class="nv">string</span> <span class="o">|</span> <span class="nf">split</span><span class="s1">:&#39;;&#39;</span> <span class="cp">}}</span>
+<a id="__codelineno-27-4" name="__codelineno-27-4" href="#__codelineno-27-4"></a>
+<a id="__codelineno-27-5" name="__codelineno-27-5" href="#__codelineno-27-5"></a><span class="x"># Jinja</span>
+<a id="__codelineno-27-6" name="__codelineno-27-6" href="#__codelineno-27-6"></a><span class="cp">{{</span> <span class="nv">string</span> <span class="o">|</span> <span class="nf">split</span> <span class="cp">}}</span>
+<a id="__codelineno-27-7" name="__codelineno-27-7" href="#__codelineno-27-7"></a><span class="cp">{{</span> <span class="nv">string</span> <span class="o">|</span> <span class="nf">split</span><span class="o">(</span><span class="s1">&#39;;&#39;</span><span class="o">)</span> <span class="cp">}}</span>
 </code></pre></div>
 <h3 id="tzoffset">tzoffset<a class="headerlink" href="#tzoffset" title="Permanent link">&para;</a></h3>
 <p>Returns the hour offset of a given time zone using the current time.</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-25-1" name="__codelineno-25-1" href="#__codelineno-25-1"></a><span class="cp">{{</span> <span class="nv">object.time_zone</span><span class="o">|</span><span class="nf">tzoffset</span> <span class="cp">}}</span>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-28-1" name="__codelineno-28-1" href="#__codelineno-28-1"></a><span class="cp">{{</span> <span class="nv">object.time_zone</span><span class="o">|</span><span class="nf">tzoffset</span> <span class="cp">}}</span>
 </code></pre></div>
 <h3 id="validated_viewname">validated_viewname<a class="headerlink" href="#validated_viewname" title="Permanent link">&para;</a></h3>
 <p>Return the view name for the given model and action if valid, or None if invalid.</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-26-1" name="__codelineno-26-1" href="#__codelineno-26-1"></a><span class="x"># Django Template</span>
-<a id="__codelineno-26-2" name="__codelineno-26-2" href="#__codelineno-26-2"></a><span class="cp">{{</span> <span class="nv">obj</span> <span class="o">|</span> <span class="nf">validated_viewname</span><span class="s1">:&#39;list&#39;</span> <span class="cp">}}</span>
-<a id="__codelineno-26-3" name="__codelineno-26-3" href="#__codelineno-26-3"></a>
-<a id="__codelineno-26-4" name="__codelineno-26-4" href="#__codelineno-26-4"></a><span class="x"># Jinja</span>
-<a id="__codelineno-26-5" name="__codelineno-26-5" href="#__codelineno-26-5"></a><span class="cp">{{</span> <span class="nv">obj</span> <span class="o">|</span> <span class="nf">validated_viewname</span><span class="o">(</span><span class="s1">&#39;list&#39;</span><span class="o">)</span> <span class="cp">}}</span>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-29-1" name="__codelineno-29-1" href="#__codelineno-29-1"></a><span class="x"># Django Template</span>
+<a id="__codelineno-29-2" name="__codelineno-29-2" href="#__codelineno-29-2"></a><span class="cp">{{</span> <span class="nv">obj</span> <span class="o">|</span> <span class="nf">validated_viewname</span><span class="s1">:&#39;list&#39;</span> <span class="cp">}}</span>
+<a id="__codelineno-29-3" name="__codelineno-29-3" href="#__codelineno-29-3"></a>
+<a id="__codelineno-29-4" name="__codelineno-29-4" href="#__codelineno-29-4"></a><span class="x"># Jinja</span>
+<a id="__codelineno-29-5" name="__codelineno-29-5" href="#__codelineno-29-5"></a><span class="cp">{{</span> <span class="nv">obj</span> <span class="o">|</span> <span class="nf">validated_viewname</span><span class="o">(</span><span class="s1">&#39;list&#39;</span><span class="o">)</span> <span class="cp">}}</span>
 </code></pre></div>
 <h3 id="validated_api_viewname">validated_api_viewname<a class="headerlink" href="#validated_api_viewname" title="Permanent link">&para;</a></h3>
 <p>Return the API view name for the given model and action if valid, or None if invalid.</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-27-1" name="__codelineno-27-1" href="#__codelineno-27-1"></a><span class="x"># Django Template</span>
-<a id="__codelineno-27-2" name="__codelineno-27-2" href="#__codelineno-27-2"></a><span class="cp">{{</span> <span class="nv">obj</span> <span class="o">|</span> <span class="nf">validated_api_viewname</span><span class="s1">:&#39;detail&#39;</span> <span class="cp">}}</span>
-<a id="__codelineno-27-3" name="__codelineno-27-3" href="#__codelineno-27-3"></a>
-<a id="__codelineno-27-4" name="__codelineno-27-4" href="#__codelineno-27-4"></a><span class="x"># Jinja</span>
-<a id="__codelineno-27-5" name="__codelineno-27-5" href="#__codelineno-27-5"></a><span class="cp">{{</span> <span class="nv">obj</span> <span class="o">|</span> <span class="nf">validated_api_viewname</span><span class="o">(</span><span class="s1">&#39;detail&#39;</span><span class="o">)</span> <span class="cp">}}</span>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-30-1" name="__codelineno-30-1" href="#__codelineno-30-1"></a><span class="x"># Django Template</span>
+<a id="__codelineno-30-2" name="__codelineno-30-2" href="#__codelineno-30-2"></a><span class="cp">{{</span> <span class="nv">obj</span> <span class="o">|</span> <span class="nf">validated_api_viewname</span><span class="s1">:&#39;detail&#39;</span> <span class="cp">}}</span>
+<a id="__codelineno-30-3" name="__codelineno-30-3" href="#__codelineno-30-3"></a>
+<a id="__codelineno-30-4" name="__codelineno-30-4" href="#__codelineno-30-4"></a><span class="x"># Jinja</span>
+<a id="__codelineno-30-5" name="__codelineno-30-5" href="#__codelineno-30-5"></a><span class="cp">{{</span> <span class="nv">obj</span> <span class="o">|</span> <span class="nf">validated_api_viewname</span><span class="o">(</span><span class="s1">&#39;detail&#39;</span><span class="o">)</span> <span class="cp">}}</span>
 </code></pre></div>
 <h3 id="viewname">viewname<a class="headerlink" href="#viewname" title="Permanent link">&para;</a></h3>
 <p>Return the view name for the given model and action. Does not perform any validation.</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-28-1" name="__codelineno-28-1" href="#__codelineno-28-1"></a><span class="x"># Django Template</span>
-<a id="__codelineno-28-2" name="__codelineno-28-2" href="#__codelineno-28-2"></a><span class="cp">{{</span> <span class="nv">obj</span> <span class="o">|</span> <span class="nf">viewname</span><span class="s1">:&#39;list&#39;</span> <span class="cp">}}</span>
-<a id="__codelineno-28-3" name="__codelineno-28-3" href="#__codelineno-28-3"></a>
-<a id="__codelineno-28-4" name="__codelineno-28-4" href="#__codelineno-28-4"></a><span class="x"># Jinja</span>
-<a id="__codelineno-28-5" name="__codelineno-28-5" href="#__codelineno-28-5"></a><span class="cp">{{</span> <span class="nv">obj</span> <span class="o">|</span> <span class="nf">viewname</span><span class="o">(</span><span class="s1">&#39;list&#39;</span><span class="o">)</span> <span class="cp">}}</span>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-31-1" name="__codelineno-31-1" href="#__codelineno-31-1"></a><span class="x"># Django Template</span>
+<a id="__codelineno-31-2" name="__codelineno-31-2" href="#__codelineno-31-2"></a><span class="cp">{{</span> <span class="nv">obj</span> <span class="o">|</span> <span class="nf">viewname</span><span class="s1">:&#39;list&#39;</span> <span class="cp">}}</span>
+<a id="__codelineno-31-3" name="__codelineno-31-3" href="#__codelineno-31-3"></a>
+<a id="__codelineno-31-4" name="__codelineno-31-4" href="#__codelineno-31-4"></a><span class="x"># Jinja</span>
+<a id="__codelineno-31-5" name="__codelineno-31-5" href="#__codelineno-31-5"></a><span class="cp">{{</span> <span class="nv">obj</span> <span class="o">|</span> <span class="nf">viewname</span><span class="o">(</span><span class="s1">&#39;list&#39;</span><span class="o">)</span> <span class="cp">}}</span>
 </code></pre></div>
 
 
@@ -9900,10 +10375,10 @@ additionally if there is an <code>object.description</code> this will be used as
     </div>
     
     
-    <script id="__config" type="application/json">{"base": "../..", "features": ["content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
+    <script id="__config" type="application/json">{"base": "../..", "features": ["content.code.annotate", "content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
     
     
-      <script src="../../assets/javascripts/bundle.83f73b43.min.js"></script>
+      <script src="../../assets/javascripts/bundle.88dd0f4e.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>