nautobot 2.4.14__py3-none-any.whl → 2.4.15__py3-none-any.whl

nautobot/project-static/docs/code-reference/nautobot/apps/utils.html

@@ -9430,6 +9430,29 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../development/apps/migration/ui-component-framework/breadcrumbs-titles.html" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    Breadcrumbs and titles
+    
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -11559,6 +11582,7 @@
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11581,7 +11605,7 @@
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.utils.FeaturedQueryMixin" href="#nautobot.apps.utils.FeaturedQueryMixin">FeaturedQueryMixin</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.utils.FeaturedQueryMixin (nautobot.extras.utils.FeaturedQueryMixin)" href="#nautobot.apps.utils.FeaturedQueryMixin">FeaturedQueryMixin</a></code></p>
 
 
         <p>Helper class to get ContentType for models that implements the to_objectchange method for change logging.</p>
@@ -11594,6 +11618,7 @@
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11617,6 +11642,7 @@
 
         <p>Return a list of classes that implement the to_objectchange method</p>
 
+
     </div>
 
 </div>
@@ -11654,6 +11680,7 @@ until it has been populated.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11679,6 +11706,7 @@ until it has been populated.</p>
 <p>Misnamed, as it returns an iterable of (key, value) (i.e. dict.items()) rather than an actual dict.</p>
 <p>Raises a KeyError if the given feature doesn't exist.</p>
 
+
     </div>
 
 </div>
@@ -11701,6 +11729,7 @@ suitable for use as <code>choices</code> on a choice field:</p>
 </code></pre></div>
 <p>Cache is cleared by post_migrate signal (nautobot.extras.signals.post_migrate_clear_content_type_caches).</p>
 
+
     </div>
 
 </div>
@@ -11718,6 +11747,7 @@ suitable for use as <code>choices</code> on a choice field:</p>
 
         <p>Given an extras feature, return a Q object for content type lookup</p>
 
+
     </div>
 
 </div>
@@ -11736,6 +11766,7 @@ suitable for use as <code>choices</code> on a choice field:</p>
         <p>Return a list of model classes that declare this feature.</p>
 <p>Cache is cleared by post_migrate signal (nautobot.extras.signals.post_migrate_clear_content_type_caches).</p>
 
+
     </div>
 
 </div>
@@ -11772,6 +11803,7 @@ suitable for use as <code>choices</code> on a choice field:</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11795,6 +11827,7 @@ suitable for use as <code>choices</code> on a choice field:</p>
 
         <p>Given an extras feature, return a Q object for content type lookup</p>
 
+
     </div>
 
 </div>
@@ -11812,6 +11845,7 @@ suitable for use as <code>choices</code> on a choice field:</p>
 
         <p>Return a list of classes that has implements this <code>name</code>.</p>
 
+
     </div>
 
 </div>
@@ -11846,6 +11880,7 @@ suitable for use as <code>choices</code> on a choice field:</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11871,6 +11906,7 @@ suitable for use as <code>choices</code> on a choice field:</p>
     <div class="doc doc-contents ">
 
         <p>Current checked out repository head commit.</p>
+
     </div>
 
 </div>
@@ -11907,7 +11943,7 @@ suitable for use as <code>choices</code> on a choice field:</p>
                 <code>path</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11923,7 +11959,7 @@ suitable for use as <code>choices</code> on a choice field:</p>
                 <code>url</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11939,7 +11975,7 @@ suitable for use as <code>choices</code> on a choice field:</p>
                 <code>clone_initially</code>
             </td>
             <td>
-                  <code>bool</code>
+                  <code><span title="bool">bool</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11955,7 +11991,7 @@ suitable for use as <code>choices</code> on a choice field:</p>
                 <code>branch</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11971,7 +12007,7 @@ suitable for use as <code>choices</code> on a choice field:</p>
                 <code>depth</code>
             </td>
             <td>
-                  <code>int</code>
+                  <code><span title="int">int</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11985,6 +12021,7 @@ suitable for use as <code>choices</code> on a choice field:</p>
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -12019,7 +12056,7 @@ suitable for use as <code>choices</code> on a choice field:</p>
                 <code>branch</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12035,7 +12072,7 @@ suitable for use as <code>choices</code> on a choice field:</p>
                 <code>commit_hexsha</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12063,7 +12100,7 @@ If <code>commit_hexsha</code> is specified and <code>branch</code> is a branch n
       <tbody>
           <tr class="doc-section-item">
             <td>
-                  <code>(str, bool)</code>
+                  <code>(<span title="str">str</span>, <span title="bool">bool</span>)</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12074,6 +12111,7 @@ If <code>commit_hexsha</code> is specified and <code>branch</code> is a branch n
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -12099,7 +12137,7 @@ If <code>commit_hexsha</code> is specified and <code>branch</code> is a branch n
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.utils.FeaturedQueryMixin" href="#nautobot.apps.utils.FeaturedQueryMixin">FeaturedQueryMixin</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.utils.FeaturedQueryMixin (nautobot.extras.utils.FeaturedQueryMixin)" href="#nautobot.apps.utils.FeaturedQueryMixin">FeaturedQueryMixin</a></code></p>
 
 
         <p>Helper class to get ContentType models that implements role.</p>
@@ -12112,6 +12150,7 @@ If <code>commit_hexsha</code> is specified and <code>branch</code> is a branch n
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12135,6 +12174,7 @@ If <code>commit_hexsha</code> is specified and <code>branch</code> is a branch n
 
         <p>Return a list of classes that implements roles e.g roles = ...</p>
 
+
     </div>
 
 </div>
@@ -12160,7 +12200,7 @@ If <code>commit_hexsha</code> is specified and <code>branch</code> is a branch n
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.utils.FeaturedQueryMixin" href="#nautobot.apps.utils.FeaturedQueryMixin">FeaturedQueryMixin</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.utils.FeaturedQueryMixin (nautobot.extras.utils.FeaturedQueryMixin)" href="#nautobot.apps.utils.FeaturedQueryMixin">FeaturedQueryMixin</a></code></p>
 
 
         <p>Helper class to get ContentType models that implements tags(TagsField)</p>
@@ -12173,6 +12213,7 @@ If <code>commit_hexsha</code> is specified and <code>branch</code> is a branch n
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12196,6 +12237,7 @@ If <code>commit_hexsha</code> is specified and <code>branch</code> is a branch n
 
         <p>Return a list of classes that has implements tags e.g tags = TagsField(...)</p>
 
+
     </div>
 
 </div>
@@ -12239,7 +12281,7 @@ If <code>commit_hexsha</code> is specified and <code>branch</code> is a branch n
                 <code>field_name</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12255,7 +12297,7 @@ If <code>commit_hexsha</code> is specified and <code>branch</code> is a branch n
                 <code>_verbose_name</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12275,6 +12317,7 @@ If <code>commit_hexsha</code> is specified and <code>branch</code> is a branch n
 <a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="gp">&gt;&gt;&gt; </span><span class="s2">&quot;ends-with (iew)&quot;</span>
 </code></pre></div>
 
+
     </div>
 
 </div>
@@ -12293,6 +12336,7 @@ If <code>commit_hexsha</code> is specified and <code>branch</code> is a branch n
         <p>Helper method to check if a key field is Python/GraphQL safe.
 Used in CustomField, ComputedField and Relationship models.</p>
 
+
     </div>
 
 </div>
@@ -12310,6 +12354,7 @@ Used in CustomField, ComputedField and Relationship models.</p>
 
         <p>Decorator to mark a class as deprecated with a custom message about what to do instead of subclassing it.</p>
 
+
     </div>
 
 </div>
@@ -12327,6 +12372,7 @@ Used in CustomField, ComputedField and Relationship models.</p>
 
         <p>Decorator to mark a class as deprecated and suggest a replacement class if it is subclassed from.</p>
 
+
     </div>
 
 </div>
@@ -12351,6 +12397,7 @@ Example:
         &gt;&gt;&gt; print(convert_git_diff_log_to_list(git_log))
         ["Modification - index.html", "Renaming - sample.txt"]</p>
 
+
     </div>
 
 </div>
@@ -12402,7 +12449,7 @@ while discarding <code>querydict</code> params which are not part of <code>filte
                 <code>filterset</code>
             </td>
             <td>
-                  <code>FilterSet</code>
+                  <code><span title="FilterSet">FilterSet</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12433,6 +12480,7 @@ while discarding <code>querydict</code> params which are not part of <code>filte
 <a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a><span class="gp">... </span><span class="p">}</span>
 </code></pre></div>
 
+
     </div>
 
 </div>
@@ -12451,6 +12499,7 @@ while discarding <code>querydict</code> params which are not part of <code>filte
         <p>Decorator that wraps a models existing clean method to also execute registered plugin custom validators</p>
 <p>:param model_clean_func: The original model clean method which is to be wrapped</p>
 
+
     </div>
 
 </div>
@@ -12468,6 +12517,7 @@ while discarding <code>querydict</code> params which are not part of <code>filte
 
         <p>Deep merge two dictionaries (new into original) and return a new dict</p>
 
+
     </div>
 
 </div>
@@ -12486,6 +12536,7 @@ while discarding <code>querydict</code> params which are not part of <code>filte
         <p>Ensure <code>query_params</code> includes <code>content_type</code> and <code>field_name</code> and <code>content_type</code> is a valid ContentType.</p>
 <p>Return the 'ContentTypes' model and 'field_name' if validation was successful.</p>
 
+
     </div>
 
 </div>
@@ -12503,6 +12554,7 @@ while discarding <code>querydict</code> params which are not part of <code>filte
 
         <p>For instances of model that have an invalid NULL status field, create and use a special status_model instance.</p>
 
+
     </div>
 
 </div>
@@ -12523,6 +12575,7 @@ while discarding <code>querydict</code> params which are not part of <code>filte
 :param prefix: Initial prefix (if any)
 :param separator: The character to use when concatenating key names</p>
 
+
     </div>
 
 </div>
@@ -12542,6 +12595,7 @@ while discarding <code>querydict</code> params which are not part of <code>filte
 <p>:param iterable: The iterable to be flattened
 :returns: generator</p>
 
+
     </div>
 
 </div>
@@ -12559,6 +12613,7 @@ while discarding <code>querydict</code> params which are not part of <code>filte
 
         <p>Return the ideal foreground color (black or white) for a given background color in hexadecimal RGB format.</p>
 
+
     </div>
 
 </div>
@@ -12576,6 +12631,7 @@ while discarding <code>querydict</code> params which are not part of <code>filte
 
         <p>Return a cryptographic signature that can be used to verify the authenticity of webhook data.</p>
 
+
     </div>
 
 </div>
@@ -12593,6 +12649,7 @@ while discarding <code>querydict</code> params which are not part of <code>filte
 
         <p>Return all lookup expressions for <code>field_name</code> in <code>model</code> filterset</p>
 
+
     </div>
 
 </div>
@@ -12627,7 +12684,7 @@ while discarding <code>querydict</code> params which are not part of <code>filte
                 <code>base_template</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12663,6 +12720,7 @@ If all else fails, returns <code>"generic/object_retrieve.html"</code>.</p>
 <p>Note: before Nautobot 2.4.2, this API would default to "base.html" rather than "generic/object_retrieve.html".
 This behavior was changed to the current behavior to address issue #6550 and similar incorrect behavior.</p>
 
+
     </div>
 
 </div>
@@ -12681,6 +12739,7 @@ This behavior was changed to the current behavior to address issue #6550 and sim
         <p>Return a dictionary of celery queues and the number of workers active on the queue in
 the form {queue_name: num_workers}</p>
 
+
     </div>
 
 </div>
@@ -12699,6 +12758,7 @@ the form {queue_name: num_workers}</p>
         <p>Return a queryset of ObjectChanges for a model or instance. The queryset will be filtered
 by the model class. If an instance is provided, the queryset will also be filtered by the instance id.</p>
 
+
     </div>
 
 </div>
@@ -12733,7 +12793,7 @@ by the model class. If an instance is provided, the queryset will also be filter
                 <code>filter_field</code>
             </td>
             <td>
-                  <code>Filter</code>
+                  <code><span title="Filter">Filter</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12759,7 +12819,7 @@ by the model class. If an instance is provided, the queryset will also be filter
       <tbody>
           <tr class="doc-section-item">
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12770,6 +12830,7 @@ by the model class. If an instance is provided, the queryset will also be filter
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -12821,7 +12882,7 @@ to return only queryset filterable parameters.</p>
                 <code>non_filter_params</code>
             </td>
             <td>
-                  <code>list</code>
+                  <code><span title="list">list</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12837,7 +12898,7 @@ to return only queryset filterable parameters.</p>
                 <code>filterset</code>
             </td>
             <td>
-                  <code>FilterSet</code>
+                  <code><span title="FilterSet">FilterSet</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12874,6 +12935,7 @@ to return only queryset filterable parameters.</p>
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -12911,7 +12973,7 @@ associated with the model and its name is expected to be <code>{ModelName}Filter
                 <code>model</code>
             </td>
             <td>
-                  <code>BaseModel</code>
+                  <code><span title="BaseModel">BaseModel</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12937,7 +12999,7 @@ associated with the model and its name is expected to be <code>{ModelName}Filter
       <tbody>
           <tr class="doc-section-item">
             <td>
-                  <code>Union[FilterSet, None]</code>
+                  <code><span title="Union">Union</span>[<span title="FilterSet">FilterSet</span>, None]</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12948,6 +13010,7 @@ associated with the model and its name is expected to be <code>{ModelName}Filter
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -12965,6 +13028,7 @@ associated with the model and its name is expected to be <code>{ModelName}Filter
 
         <p>Return the relevant form field instance for a filterset parameter e.g DynamicModelMultipleChoiceField, forms.IntegerField e.t.c</p>
 
+
     </div>
 
 </div>
@@ -13002,7 +13066,7 @@ associated with the model and its name is expected to be <code>{ModelName}{form_
                 <code>form_prefix</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13029,7 +13093,7 @@ associated with the model and its name is expected to be <code>{ModelName}{form_
       <tbody>
           <tr class="doc-section-item">
             <td>
-                  <code>Union[Form, None]</code>
+                  <code><span title="Union">Union</span>[<span title="Form">Form</span>, None]</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13040,6 +13104,7 @@ associated with the model and its name is expected to be <code>{ModelName}{form_
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -13069,7 +13134,7 @@ associated with the model and its name is expected to be <code>{ModelName}{form_
       <tbody>
           <tr class="doc-section-item">
             <td>
-                  <code>(Version, str)</code>
+                  <code>(<span title="Version">Version</span>, <span title="str">str</span>)</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13079,7 +13144,7 @@ associated with the model and its name is expected to be <code>{ModelName}{form_
           </tr>
           <tr class="doc-section-item">
             <td>
-                  <code>(unknown, None)</code>
+                  <code>(<span title="unknown">unknown</span>, None)</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13090,6 +13155,7 @@ associated with the model and its name is expected to be <code>{ModelName}{form_
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -13111,6 +13177,7 @@ associated with the model and its name is expected to be <code>{ModelName}{form_
 <p>:raises TypeError: If given model name is not found.</p>
 <p>:return: Found model.</p>
 
+
     </div>
 
 </div>
@@ -13130,6 +13197,7 @@ associated with the model and its name is expected to be <code>{ModelName}{form_
 <p>:param model: A model or instance
 :param action: View, add, change, or delete (string)</p>
 
+
     </div>
 
 </div>
@@ -13169,7 +13237,7 @@ associated with the model and its name is expected to be <code>{ModelName}{objec
                 <code>model</code>
             </td>
             <td>
-                  <code>Union[BaseModel, str]</code>
+                  <code><span title="Union">Union</span>[<span title="BaseModel">BaseModel</span>, <span title="str">str</span>]</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13185,7 +13253,7 @@ associated with the model and its name is expected to be <code>{ModelName}{objec
                 <code>module_name</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13201,7 +13269,7 @@ associated with the model and its name is expected to be <code>{ModelName}{objec
                 <code>object_suffix</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13227,7 +13295,7 @@ associated with the model and its name is expected to be <code>{ModelName}{objec
       <tbody>
           <tr class="doc-section-item">
             <td>
-                  <code>Union[BaseModel, str]</code>
+                  <code><span title="Union">Union</span>[<span title="BaseModel">BaseModel</span>, <span title="str">str</span>]</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13238,6 +13306,7 @@ associated with the model and its name is expected to be <code>{ModelName}{objec
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -13274,7 +13343,7 @@ If more than one such field is found, raises an AttributeError.</p>
                 <code>from_model</code>
             </td>
             <td>
-                  <code>BaseModel</code>
+                  <code><span title="BaseModel">BaseModel</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13290,7 +13359,7 @@ If more than one such field is found, raises an AttributeError.</p>
                 <code>to_model</code>
             </td>
             <td>
-                  <code>BaseModel</code>
+                  <code><span title="BaseModel">BaseModel</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13318,6 +13387,7 @@ If more than one such field is found, raises an AttributeError.</p>
 <a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="go">AttributeError: Device has more than one relation to IPAddress: primary_ip4, primary_ip6</span>
 </code></pre></div>
 
+
     </div>
 
 </div>
@@ -13353,7 +13423,7 @@ Supports both core and App routes.</p>
                 <code>model</code>
             </td>
             <td>
-                  <code>(<span title="nautobot.core.models.Model">Model</span>, str)</code>
+                  <code>(<span title="nautobot.core.models.Model">Model</span>, <span title="str">str</span>)</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13369,7 +13439,7 @@ Supports both core and App routes.</p>
                 <code>action</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13385,7 +13455,7 @@ Supports both core and App routes.</p>
                 <code>api</code>
             </td>
             <td>
-                  <code>bool</code>
+                  <code><span title="bool">bool</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13411,7 +13481,7 @@ Supports both core and App routes.</p>
       <tbody>
           <tr class="doc-section-item">
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13438,6 +13508,7 @@ Supports both core and App routes.</p>
 <a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a><span class="go">&quot;plugins-api:example_app-api:examplemodel-list&quot;</span>
 </code></pre></div>
 
+
     </div>
 
 </div>
@@ -13457,6 +13528,7 @@ Supports both core and App routes.</p>
 <p>The fallback value is returned <em>only</em> if the requested variable cannot be found at all - this is an error case,
 and will generate warning logs.</p>
 
+
     </div>
 
 </div>
@@ -13494,7 +13566,7 @@ associated with the model and its name is expected to be <code>{ModelName}Table<
                 <code>model</code>
             </td>
             <td>
-                  <code>BaseModel</code>
+                  <code><span title="BaseModel">BaseModel</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13510,7 +13582,7 @@ associated with the model and its name is expected to be <code>{ModelName}Table<
                 <code>suffix</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13536,7 +13608,7 @@ associated with the model and its name is expected to be <code>{ModelName}Table<
       <tbody>
           <tr class="doc-section-item">
             <td>
-                  <code>Union[Table, None]</code>
+                  <code><span title="Union">Union</span>[<span title="Table">Table</span>, None]</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13547,6 +13619,7 @@ associated with the model and its name is expected to be <code>{ModelName}Table<
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -13572,6 +13645,7 @@ associated with the model and its name is expected to be <code>{ModelName}Table<
 <a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="go">&#39;/circuits/circuit-terminations/00000000-0000-0000-0000-000000000000/connect/string/&#39;</span>
 </code></pre></div>
 
+
     </div>
 
 </div>
@@ -13606,7 +13680,7 @@ associated with the model and its name is expected to be <code>{ModelName}Table<
                 <code>urlconf</code>
             </td>
             <td>
-                  <code>URLConf</code>
+                  <code><span title="URLConf">URLConf</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13623,7 +13697,7 @@ Default if unspecified is the value of <code>settings.ROOT_URLCONF</code>, i.e.
                 <code>patterns_list</code>
             </td>
             <td>
-                  <code>list</code>
+                  <code><span title="list">list</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13640,7 +13714,7 @@ Default if unspecified is the <code>url_patterns</code> attribute of the given <
                 <code>base_path</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13657,7 +13731,7 @@ Default if unspecified is the string <code>"/"</code>.</p>
                 <code>ignore_redirects</code>
             </td>
             <td>
-                  <code>bool</code>
+                  <code><span title="bool">bool</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13683,7 +13757,7 @@ Default if unspecified is the string <code>"/"</code>.</p>
       <tbody>
           <tr class="doc-section-item">
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13743,6 +13817,7 @@ Default if unspecified is the string <code>"/"</code>.</p>
 <a id="__codelineno-0-33" name="__codelineno-0-33" href="#__codelineno-0-33"></a><span class="go">/plugins/example-app/^other-models/(?P&lt;pk&gt;[^/.]+)/notes/$</span>
 </code></pre></div>
 
+
     </div>
 
 </div>
@@ -13763,6 +13838,7 @@ Default if unspecified is the string <code>"/"</code>.</p>
 and its name is expected to be either <code>{ModelName}UIViewSet</code> or <code>{ModelName}{view_type}View</code>.</p>
 <p>If neither view class is found, this will return <code>None</code>.</p>
 
+
     </div>
 
 </div>
@@ -13797,7 +13873,7 @@ and its name is expected to be either <code>{ModelName}UIViewSet</code> or <code
                 <code>queue</code>
             </td>
             <td>
-                  <code>(str, <span title="nautobot.extras.models.JobQueue">JobQueue</span>, None)</code>
+                  <code>(<span title="str">str</span>, <span title="nautobot.extras.models.JobQueue">JobQueue</span>, None)</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13811,6 +13887,7 @@ and its name is expected to be either <code>{ModelName}UIViewSet</code> or <code
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -13828,6 +13905,7 @@ and its name is expected to be either <code>{ModelName}UIViewSet</code> or <code
 
         <p>Map a hex string like "00ff00" to individual r, g, b integer values.</p>
 
+
     </div>
 
 </div>
@@ -13845,6 +13923,7 @@ and its name is expected to be either <code>{ModelName}UIViewSet</code> or <code
 
         <p>Return a path for uploading image attachments.</p>
 
+
     </div>
 
 </div>
@@ -13879,7 +13958,7 @@ and its name is expected to be either <code>{ModelName}UIViewSet</code> or <code
                 <code>value</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13905,7 +13984,7 @@ and its name is expected to be either <code>{ModelName}UIViewSet</code> or <code
       <tbody>
           <tr class="doc-section-item">
             <td>
-                  <code>bool</code>
+                  <code><span title="bool">bool</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -13916,6 +13995,7 @@ and its name is expected to be either <code>{ModelName}UIViewSet</code> or <code
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -13933,6 +14013,7 @@ and its name is expected to be either <code>{ModelName}UIViewSet</code> or <code
 
         <p>Make a given RGB color lighter (closer to white).</p>
 
+
     </div>
 
 </div>
@@ -13950,6 +14031,7 @@ and its name is expected to be either <code>{ModelName}UIViewSet</code> or <code
 
         <p>Merge two dicts into a new dict, but raise a ValueError if any key exists with differing values across both dicts.</p>
 
+
     </div>
 
 </div>
@@ -14013,7 +14095,7 @@ content types if an instance of the new model is using the tag.</p>
                 <code>apps</code>
             </td>
             <td>
-                  <code>obj</code>
+                  <code><span title="obj">obj</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -14029,7 +14111,7 @@ content types if an instance of the new model is using the tag.</p>
                 <code>old_ct</code>
             </td>
             <td>
-                  <code>obj</code>
+                  <code><span title="obj">obj</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -14045,7 +14127,7 @@ content types if an instance of the new model is using the tag.</p>
                 <code>new_ct</code>
             </td>
             <td>
-                  <code>obj</code>
+                  <code><span title="obj">obj</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -14059,6 +14141,7 @@ content types if an instance of the new model is using the tag.</p>
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -14109,7 +14192,7 @@ content types if an instance of the new model is using the tag.</p>
                 <code>from_role_field_name</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -14141,7 +14224,7 @@ content types if an instance of the new model is using the tag.</p>
                 <code>from_role_choiceset</code>
             </td>
             <td>
-                  <code>ChoiceSet</code>
+                  <code><span title="ChoiceSet">ChoiceSet</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -14157,7 +14240,7 @@ content types if an instance of the new model is using the tag.</p>
                 <code>to_role_field_name</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -14189,7 +14272,7 @@ content types if an instance of the new model is using the tag.</p>
                 <code>to_role_choiceset</code>
             </td>
             <td>
-                  <code>ChoiceSet</code>
+                  <code><span title="ChoiceSet">ChoiceSet</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -14205,7 +14288,7 @@ content types if an instance of the new model is using the tag.</p>
                 <code>is_m2m_field</code>
             </td>
             <td>
-                  <code>bool</code>
+                  <code><span title="bool">bool</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -14219,6 +14302,7 @@ content types if an instance of the new model is using the tag.</p>
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -14322,7 +14406,7 @@ should preserve multiple values as lists (e.g., non-single-choice fields).</p>
       <tbody>
           <tr class="doc-section-item">
             <td>
-                  <code>AttributeError</code>
+                  <code><span title="AttributeError">AttributeError</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -14333,6 +14417,7 @@ should preserve multiple values as lists (e.g., non-single-choice fields).</p>
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -14351,6 +14436,7 @@ should preserve multiple values as lists (e.g., non-single-choice fields).</p>
         <p>Determine whether a specified permission is exempt from evaluation.</p>
 <p>:param name: Permission name in the format <app_label>.<action>_<model></p>
 
+
     </div>
 
 </div>
@@ -14384,6 +14470,7 @@ should preserve multiple values as lists (e.g., non-single-choice fields).</p>
   fields with the names given in the dictionary.
 - Groups the results by app and updates the registry model features for each app.</p>
 
+
     </div>
 
 </div>
@@ -14407,6 +14494,7 @@ and in that case we need to not import models ourselves.</p>
 part of the <code>nautobot.apps.utils</code> API surface and so we need it to stay backwards-compatible with Apps that might
 be calling the two-argument form of this function.</p>
 
+
     </div>
 
 </div>
@@ -14425,6 +14513,7 @@ be calling the two-argument form of this function.</p>
         <p>field_name (str): f"cf_{cf.key}"</p>
 <p>Helper method to remove the "cf_" prefix</p>
 
+
     </div>
 
 </div>
@@ -14442,6 +14531,7 @@ be calling the two-argument form of this function.</p>
 
         <p>Render a Jinja2 template with the provided context. Return the rendered content.</p>
 
+
     </div>
 
 </div>
@@ -14461,6 +14551,7 @@ be calling the two-argument form of this function.</p>
 returns ("dcim", "view", "location").</p>
 <p>:param name: Permission name in the format <app_label>.<action>_<model></p>
 
+
     </div>
 
 </div>
@@ -14480,6 +14571,7 @@ returns ("dcim", "view", "location").</p>
 (Location, "view").</p>
 <p>:param name: Permission name in the format <app_label>.<action>_<model></p>
 
+
     </div>
 
 </div>
@@ -14497,6 +14589,7 @@ returns ("dcim", "view", "location").</p>
 
         <p>Map r, g, b values to a hex string.</p>
 
+
     </div>
 
 </div>
@@ -14516,6 +14609,7 @@ returns ("dcim", "view", "location").</p>
 <p>Obviously this will never be 100% foolproof but we can at least try.</p>
 <p>Uses settings.SANITIZER_PATTERNS as the list of (regexp, repl) tuples to apply.</p>
 
+
     </div>
 
 </div>
@@ -14534,6 +14628,7 @@ returns ("dcim", "view", "location").</p>
         <p>Return a new dictionary of the different keys. The values of <code>destination_dict</code> are returned. Only the equality of
 the first layer of keys/values is checked. <code>exclude</code> is a list or tuple of keys to be ignored.</p>
 
+
     </div>
 
 </div>
@@ -14551,6 +14646,7 @@ the first layer of keys/values is checked. <code>exclude</code> is a list or tup
 
         <p>Swap Git status initials with its equivalent.</p>
 
+
     </div>
 
 </div>
@@ -14569,6 +14665,7 @@ the first layer of keys/values is checked. <code>exclude</code> is a list or tup
         <p>Returns a list of 2-tuples for use in the form field <code>choices</code> argument. Appends
 worker count to the description.</p>
 
+
     </div>
 
 </div>
@@ -14586,6 +14683,7 @@ worker count to the description.</p>
 
         <p>Convert the given length to meters.</p>
 
+
     </div>
 
 </div>
@@ -14603,6 +14701,7 @@ worker count to the description.</p>
 
         <p>Helper function that wraps plugin model validator registered clean methods for all applicable models</p>
 
+
     </div>
 
 </div>