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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of nautobot might be problematic. Click here for more details.

Files changed (592) hide show
  1. nautobot/apps/__init__.py +1 -1
  2. nautobot/apps/api.py +8 -8
  3. nautobot/apps/change_logging.py +2 -2
  4. nautobot/apps/choices.py +4 -4
  5. nautobot/apps/events.py +3 -3
  6. nautobot/apps/factory.py +2 -2
  7. nautobot/apps/filters.py +1 -1
  8. nautobot/apps/forms.py +20 -20
  9. nautobot/apps/graphql.py +2 -2
  10. nautobot/apps/jobs.py +8 -8
  11. nautobot/apps/models.py +19 -19
  12. nautobot/apps/tables.py +1 -1
  13. nautobot/apps/testing.py +10 -10
  14. nautobot/apps/ui.py +2 -2
  15. nautobot/apps/utils.py +7 -7
  16. nautobot/apps/views.py +7 -7
  17. nautobot/circuits/api/serializers.py +0 -1
  18. nautobot/circuits/api/views.py +8 -4
  19. nautobot/circuits/tables.py +1 -2
  20. nautobot/circuits/templates/circuits/circuit_create.html +7 -1
  21. nautobot/circuits/views.py +3 -3
  22. nautobot/cloud/api/views.py +10 -6
  23. nautobot/cloud/models.py +1 -1
  24. nautobot/cloud/views.py +16 -0
  25. nautobot/core/api/fields.py +5 -5
  26. nautobot/core/api/filter_backends.py +9 -3
  27. nautobot/core/api/schema.py +2 -13
  28. nautobot/core/api/serializers.py +34 -40
  29. nautobot/core/api/views.py +4 -56
  30. nautobot/core/celery/log.py +4 -4
  31. nautobot/core/celery/schedulers.py +1 -1
  32. nautobot/core/choices.py +2 -2
  33. nautobot/core/events/__init__.py +3 -3
  34. nautobot/core/filters.py +16 -21
  35. nautobot/core/fixtures/user-data.json +59 -0
  36. nautobot/core/forms/__init__.py +19 -19
  37. nautobot/core/forms/fields.py +11 -14
  38. nautobot/core/forms/forms.py +2 -33
  39. nautobot/core/graphql/types.py +1 -1
  40. nautobot/core/jobs/__init__.py +7 -28
  41. nautobot/core/jobs/cleanup.py +12 -48
  42. nautobot/core/jobs/groups.py +1 -1
  43. nautobot/core/management/commands/validate_models.py +1 -1
  44. nautobot/core/models/__init__.py +1 -1
  45. nautobot/core/models/query_functions.py +2 -2
  46. nautobot/core/models/tree_queries.py +3 -6
  47. nautobot/core/settings.py +2 -29
  48. nautobot/core/settings.yaml +0 -21
  49. nautobot/core/tables.py +60 -74
  50. nautobot/core/templates/inc/media.html +0 -3
  51. nautobot/core/templates/inc/nav_menu.html +0 -1
  52. nautobot/core/templates/nautobot_config.py.j2 +0 -13
  53. nautobot/core/templates/search.html +0 -7
  54. nautobot/core/templates/utilities/render_jinja2.html +1 -1
  55. nautobot/core/templates/utilities/templatetags/tag.html +1 -1
  56. nautobot/core/templates/utilities/theme_preview.html +0 -7
  57. nautobot/core/templatetags/helpers.py +2 -11
  58. nautobot/core/testing/__init__.py +8 -8
  59. nautobot/core/testing/api.py +15 -170
  60. nautobot/core/testing/filters.py +2 -25
  61. nautobot/core/testing/forms.py +0 -2
  62. nautobot/core/testing/mixins.py +2 -7
  63. nautobot/core/testing/views.py +29 -44
  64. nautobot/core/tests/integration/test_app_home.py +1 -0
  65. nautobot/core/tests/integration/test_app_navbar.py +1 -0
  66. nautobot/core/tests/integration/test_filters.py +2 -0
  67. nautobot/core/tests/integration/test_home.py +1 -0
  68. nautobot/core/tests/integration/test_navbar.py +1 -0
  69. nautobot/core/tests/integration/test_view_authentication.py +0 -1
  70. nautobot/core/tests/runner.py +1 -1
  71. nautobot/core/tests/test_api.py +1 -98
  72. nautobot/core/tests/test_csv.py +3 -25
  73. nautobot/core/tests/test_forms.py +0 -1
  74. nautobot/core/tests/test_jobs.py +1 -303
  75. nautobot/core/tests/test_settings_schema.py +0 -7
  76. nautobot/core/tests/test_tables.py +0 -100
  77. nautobot/core/tests/test_utils.py +1 -63
  78. nautobot/core/tests/test_views.py +3 -30
  79. nautobot/core/ui/nav.py +0 -1
  80. nautobot/core/ui/object_detail.py +1 -15
  81. nautobot/core/urls.py +0 -11
  82. nautobot/core/utils/lookup.py +8 -11
  83. nautobot/core/utils/requests.py +9 -24
  84. nautobot/core/views/__init__.py +0 -42
  85. nautobot/core/views/generic.py +176 -78
  86. nautobot/core/views/mixins.py +34 -94
  87. nautobot/core/views/renderers.py +6 -6
  88. nautobot/dcim/api/serializers.py +62 -54
  89. nautobot/dcim/api/views.py +113 -47
  90. nautobot/dcim/filters/__init__.py +2 -31
  91. nautobot/dcim/forms.py +17 -36
  92. nautobot/dcim/graphql/types.py +2 -2
  93. nautobot/dcim/models/__init__.py +1 -1
  94. nautobot/dcim/models/device_component_templates.py +2 -2
  95. nautobot/dcim/models/device_components.py +20 -22
  96. nautobot/dcim/models/devices.py +1 -10
  97. nautobot/dcim/models/locations.py +3 -3
  98. nautobot/dcim/models/power.py +5 -6
  99. nautobot/dcim/models/racks.py +4 -4
  100. nautobot/dcim/tables/__init__.py +3 -3
  101. nautobot/dcim/tables/devices.py +5 -7
  102. nautobot/dcim/tables/devicetypes.py +2 -2
  103. nautobot/dcim/tables/racks.py +1 -1
  104. nautobot/dcim/templates/dcim/controller_create.html +7 -1
  105. nautobot/dcim/templates/dcim/controller_retrieve.html +9 -1
  106. nautobot/dcim/templates/dcim/controllermanageddevicegroup_create.html +0 -2
  107. nautobot/dcim/templates/dcim/controllermanageddevicegroup_retrieve.html +0 -5
  108. nautobot/dcim/templates/dcim/device.html +9 -1
  109. nautobot/dcim/templates/dcim/device_edit.html +37 -36
  110. nautobot/dcim/templates/dcim/location.html +9 -1
  111. nautobot/dcim/templates/dcim/location_edit.html +7 -1
  112. nautobot/dcim/templates/dcim/rack.html +9 -1
  113. nautobot/dcim/templates/dcim/rack_edit.html +7 -1
  114. nautobot/dcim/templates/dcim/rackreservation.html +9 -1
  115. nautobot/dcim/templates/dcim/virtualdevicecontext_retrieve.html +9 -1
  116. nautobot/dcim/templates/dcim/virtualdevicecontext_update.html +7 -1
  117. nautobot/dcim/tests/test_api.py +3 -16
  118. nautobot/dcim/tests/test_filters.py +0 -33
  119. nautobot/dcim/tests/test_forms.py +2 -51
  120. nautobot/dcim/tests/test_graphql.py +0 -52
  121. nautobot/dcim/tests/test_models.py +5 -34
  122. nautobot/dcim/tests/test_views.py +83 -21
  123. nautobot/dcim/views.py +13 -1
  124. nautobot/extras/api/customfields.py +2 -2
  125. nautobot/extras/api/serializers.py +85 -90
  126. nautobot/extras/api/views.py +27 -22
  127. nautobot/extras/constants.py +0 -2
  128. nautobot/extras/filters/__init__.py +6 -8
  129. nautobot/extras/forms/base.py +2 -2
  130. nautobot/extras/forms/forms.py +31 -139
  131. nautobot/extras/forms/mixins.py +5 -13
  132. nautobot/extras/group_sync.py +3 -3
  133. nautobot/extras/health_checks.py +2 -1
  134. nautobot/extras/jobs.py +12 -70
  135. nautobot/extras/managers.py +1 -3
  136. nautobot/extras/migrations/0018_joblog_data_migration.py +9 -7
  137. nautobot/extras/models/__init__.py +1 -1
  138. nautobot/extras/models/contacts.py +1 -1
  139. nautobot/extras/models/customfields.py +11 -12
  140. nautobot/extras/models/groups.py +9 -11
  141. nautobot/extras/models/jobs.py +4 -23
  142. nautobot/extras/models/models.py +2 -2
  143. nautobot/extras/plugins/__init__.py +2 -13
  144. nautobot/extras/plugins/marketplace_manifest.yml +79 -84
  145. nautobot/extras/plugins/tables.py +14 -16
  146. nautobot/extras/plugins/views.py +69 -65
  147. nautobot/extras/registry.py +1 -1
  148. nautobot/extras/secrets/__init__.py +2 -2
  149. nautobot/extras/tables.py +5 -7
  150. nautobot/extras/templates/extras/dynamicgroup.html +9 -1
  151. nautobot/extras/templates/extras/job_detail.html +0 -16
  152. nautobot/extras/templates/extras/job_edit.html +0 -1
  153. nautobot/extras/templates/extras/jobqueue_retrieve.html +9 -1
  154. nautobot/extras/templates/extras/marketplace.html +11 -29
  155. nautobot/extras/templates/extras/plugin_detail.html +15 -32
  156. nautobot/extras/templates/extras/plugins_tiles.html +10 -21
  157. nautobot/extras/test_jobs/api_test_job.py +1 -1
  158. nautobot/extras/test_jobs/atomic_transaction.py +2 -2
  159. nautobot/extras/test_jobs/dry_run.py +1 -1
  160. nautobot/extras/test_jobs/fail.py +5 -5
  161. nautobot/extras/test_jobs/file_output.py +1 -1
  162. nautobot/extras/test_jobs/file_upload_fail.py +1 -1
  163. nautobot/extras/test_jobs/file_upload_pass.py +1 -1
  164. nautobot/extras/test_jobs/ipaddress_vars.py +1 -3
  165. nautobot/extras/test_jobs/jobs_module/jobs_submodule/jobs.py +1 -1
  166. nautobot/extras/test_jobs/location_with_custom_field.py +1 -1
  167. nautobot/extras/test_jobs/log_redaction.py +1 -1
  168. nautobot/extras/test_jobs/log_skip_db_logging.py +1 -1
  169. nautobot/extras/test_jobs/modify_db.py +1 -1
  170. nautobot/extras/test_jobs/object_var_optional.py +1 -1
  171. nautobot/extras/test_jobs/object_var_required.py +1 -1
  172. nautobot/extras/test_jobs/object_vars.py +1 -1
  173. nautobot/extras/test_jobs/pass.py +3 -3
  174. nautobot/extras/test_jobs/profiling.py +1 -1
  175. nautobot/extras/test_jobs/relative_import.py +3 -3
  176. nautobot/extras/test_jobs/soft_time_limit_greater_than_time_limit.py +1 -1
  177. nautobot/extras/test_jobs/task_queues.py +1 -1
  178. nautobot/extras/tests/integration/test_plugin_banner.py +2 -0
  179. nautobot/extras/tests/test_api.py +13 -13
  180. nautobot/extras/tests/test_customfields.py +1 -1
  181. nautobot/extras/tests/test_datasources.py +1 -2
  182. nautobot/extras/tests/test_dynamicgroups.py +1 -1
  183. nautobot/extras/tests/test_filters.py +6 -6
  184. nautobot/extras/tests/test_forms.py +1 -20
  185. nautobot/extras/tests/test_jobs.py +19 -160
  186. nautobot/extras/tests/test_models.py +10 -10
  187. nautobot/extras/tests/test_plugins.py +9 -62
  188. nautobot/extras/tests/test_relationships.py +9 -120
  189. nautobot/extras/tests/test_views.py +191 -52
  190. nautobot/extras/utils.py +2 -3
  191. nautobot/extras/views.py +98 -30
  192. nautobot/ipam/api/fields.py +3 -3
  193. nautobot/ipam/api/serializers.py +33 -41
  194. nautobot/ipam/api/views.py +117 -68
  195. nautobot/ipam/factory.py +1 -1
  196. nautobot/ipam/filters.py +2 -3
  197. nautobot/ipam/lookups.py +62 -101
  198. nautobot/ipam/models.py +16 -66
  199. nautobot/ipam/querysets.py +2 -2
  200. nautobot/ipam/tables.py +7 -23
  201. nautobot/ipam/templates/ipam/ipaddress.html +9 -1
  202. nautobot/ipam/templates/ipam/ipaddress_bulk_add.html +7 -1
  203. nautobot/ipam/templates/ipam/ipaddress_edit.html +7 -1
  204. nautobot/ipam/templates/ipam/prefix.html +9 -1
  205. nautobot/ipam/templates/ipam/prefix_edit.html +7 -1
  206. nautobot/ipam/templates/ipam/vlan.html +9 -1
  207. nautobot/ipam/templates/ipam/vlan_edit.html +7 -1
  208. nautobot/ipam/templates/ipam/vrf_edit.html +7 -1
  209. nautobot/ipam/tests/test_api.py +3 -416
  210. nautobot/ipam/tests/test_forms.py +47 -49
  211. nautobot/ipam/tests/test_migrations.py +30 -30
  212. nautobot/ipam/tests/test_models.py +34 -95
  213. nautobot/ipam/tests/test_querysets.py +1 -63
  214. nautobot/ipam/tests/test_views.py +0 -3
  215. nautobot/ipam/utils/__init__.py +6 -36
  216. nautobot/ipam/views.py +87 -61
  217. nautobot/project-static/bootstrap-3.4.1-dist/css/bootstrap-theme.css.map +1 -1
  218. nautobot/project-static/bootstrap-3.4.1-dist/css/bootstrap-theme.min.css.map +1 -1
  219. nautobot/project-static/bootstrap-3.4.1-dist/css/bootstrap.css +2 -40
  220. nautobot/project-static/bootstrap-3.4.1-dist/css/bootstrap.css.map +1 -1
  221. nautobot/project-static/bootstrap-3.4.1-dist/css/bootstrap.min.css +1 -1
  222. nautobot/project-static/bootstrap-3.4.1-dist/css/bootstrap.min.css.map +1 -1
  223. nautobot/project-static/docs/404.html +4 -46
  224. nautobot/project-static/docs/apps/index.html +4 -46
  225. nautobot/project-static/docs/apps/nautobot-apps.html +6 -47
  226. nautobot/project-static/docs/assets/_mkdocstrings.css +1 -25
  227. nautobot/project-static/docs/assets/javascripts/{bundle.88dd0f4e.min.js → bundle.83f73b43.min.js} +2 -2
  228. nautobot/project-static/docs/assets/javascripts/{bundle.88dd0f4e.min.js.map → bundle.83f73b43.min.js.map} +2 -2
  229. nautobot/project-static/docs/code-reference/nautobot/apps/__init__.html +10 -62
  230. nautobot/project-static/docs/code-reference/nautobot/apps/admin.html +7 -59
  231. nautobot/project-static/docs/code-reference/nautobot/apps/api.html +122 -374
  232. nautobot/project-static/docs/code-reference/nautobot/apps/change_logging.html +18 -90
  233. nautobot/project-static/docs/code-reference/nautobot/apps/choices.html +21 -95
  234. nautobot/project-static/docs/code-reference/nautobot/apps/config.html +6 -53
  235. nautobot/project-static/docs/code-reference/nautobot/apps/constants.html +5 -52
  236. nautobot/project-static/docs/code-reference/nautobot/apps/datasources.html +17 -79
  237. nautobot/project-static/docs/code-reference/nautobot/apps/events.html +28 -102
  238. nautobot/project-static/docs/code-reference/nautobot/apps/exceptions.html +21 -108
  239. nautobot/project-static/docs/code-reference/nautobot/apps/factory.html +38 -131
  240. nautobot/project-static/docs/code-reference/nautobot/apps/filters.html +65 -239
  241. nautobot/project-static/docs/code-reference/nautobot/apps/forms.html +165 -581
  242. nautobot/project-static/docs/code-reference/nautobot/apps/graphql.html +36 -109
  243. nautobot/project-static/docs/code-reference/nautobot/apps/jobs.html +167 -453
  244. nautobot/project-static/docs/code-reference/nautobot/apps/models.html +211 -493
  245. nautobot/project-static/docs/code-reference/nautobot/apps/querysets.html +8 -60
  246. nautobot/project-static/docs/code-reference/nautobot/apps/secrets.html +15 -71
  247. nautobot/project-static/docs/code-reference/nautobot/apps/tables.html +55 -407
  248. nautobot/project-static/docs/code-reference/nautobot/apps/testing.html +205 -585
  249. nautobot/project-static/docs/code-reference/nautobot/apps/ui.html +412 -858
  250. nautobot/project-static/docs/code-reference/nautobot/apps/urls.html +7 -59
  251. nautobot/project-static/docs/code-reference/nautobot/apps/utils.html +186 -448
  252. nautobot/project-static/docs/code-reference/nautobot/apps/views.html +147 -365
  253. nautobot/project-static/docs/development/apps/api/configuration-view.html +4 -46
  254. nautobot/project-static/docs/development/apps/api/database-backend-config.html +4 -46
  255. nautobot/project-static/docs/development/apps/api/models/django-admin.html +4 -46
  256. nautobot/project-static/docs/development/apps/api/models/global-search.html +4 -46
  257. nautobot/project-static/docs/development/apps/api/models/graphql.html +4 -46
  258. nautobot/project-static/docs/development/apps/api/models/index.html +4 -46
  259. nautobot/project-static/docs/development/apps/api/nautobot-app-config.html +4 -46
  260. nautobot/project-static/docs/development/apps/api/platform-features/custom-validators.html +4 -46
  261. nautobot/project-static/docs/development/apps/api/platform-features/filter-extensions.html +4 -46
  262. nautobot/project-static/docs/development/apps/api/platform-features/git-repository-content.html +4 -46
  263. nautobot/project-static/docs/development/apps/api/platform-features/index.html +4 -46
  264. nautobot/project-static/docs/development/apps/api/platform-features/jinja2-filters.html +4 -46
  265. nautobot/project-static/docs/development/apps/api/platform-features/jobs.html +4 -46
  266. nautobot/project-static/docs/development/apps/api/platform-features/populating-extensibility-features.html +4 -46
  267. nautobot/project-static/docs/development/apps/api/platform-features/secrets-providers.html +4 -46
  268. nautobot/project-static/docs/development/apps/api/platform-features/table-extensions.html +7 -68
  269. nautobot/project-static/docs/development/apps/api/platform-features/uniquely-identify-objects.html +4 -46
  270. nautobot/project-static/docs/development/apps/api/prometheus.html +4 -46
  271. nautobot/project-static/docs/development/apps/api/setup.html +4 -46
  272. nautobot/project-static/docs/development/apps/api/testing.html +4 -46
  273. nautobot/project-static/docs/development/apps/api/ui-extensions/banners.html +4 -46
  274. nautobot/project-static/docs/development/apps/api/ui-extensions/home-page.html +4 -46
  275. nautobot/project-static/docs/development/apps/api/ui-extensions/index.html +4 -46
  276. nautobot/project-static/docs/development/apps/api/ui-extensions/navigation.html +4 -46
  277. nautobot/project-static/docs/development/apps/api/ui-extensions/object-views.html +4 -46
  278. nautobot/project-static/docs/development/apps/api/views/base-template.html +4 -46
  279. nautobot/project-static/docs/development/apps/api/views/core-view-overrides.html +4 -46
  280. nautobot/project-static/docs/development/apps/api/views/django-generic-views.html +4 -46
  281. nautobot/project-static/docs/development/apps/api/views/help-documentation.html +4 -46
  282. nautobot/project-static/docs/development/apps/api/views/index.html +4 -46
  283. nautobot/project-static/docs/development/apps/api/views/nautobot-generic-views.html +4 -46
  284. nautobot/project-static/docs/development/apps/api/views/nautobotuiviewset.html +4 -46
  285. nautobot/project-static/docs/development/apps/api/views/nautobotuiviewsetrouter.html +4 -46
  286. nautobot/project-static/docs/development/apps/api/views/notes.html +4 -46
  287. nautobot/project-static/docs/development/apps/api/views/rest-api.html +6 -52
  288. nautobot/project-static/docs/development/apps/api/views/urls.html +4 -46
  289. nautobot/project-static/docs/development/apps/index.html +4 -46
  290. nautobot/project-static/docs/development/apps/migration/code-updates.html +4 -46
  291. nautobot/project-static/docs/development/apps/migration/dependency-updates.html +4 -46
  292. nautobot/project-static/docs/development/apps/migration/from-v1.html +4 -46
  293. nautobot/project-static/docs/development/apps/migration/model-updates/dcim.html +4 -46
  294. nautobot/project-static/docs/development/apps/migration/model-updates/extras.html +4 -46
  295. nautobot/project-static/docs/development/apps/migration/model-updates/global.html +4 -46
  296. nautobot/project-static/docs/development/apps/migration/model-updates/ipam.html +4 -46
  297. nautobot/project-static/docs/development/apps/migration/ui-component-framework/best-practices.html +8 -50
  298. nautobot/project-static/docs/development/apps/migration/ui-component-framework/custom-content.html +4 -46
  299. nautobot/project-static/docs/development/apps/migration/ui-component-framework/index.html +14 -211
  300. nautobot/project-static/docs/development/apps/migration/ui-component-framework/migration-steps.html +4 -46
  301. nautobot/project-static/docs/development/apps/porting-from-netbox.html +4 -46
  302. nautobot/project-static/docs/development/core/application-registry.html +4 -46
  303. nautobot/project-static/docs/development/core/best-practices.html +4 -46
  304. nautobot/project-static/docs/development/core/bootstrap-ui.html +4 -46
  305. nautobot/project-static/docs/development/core/caching.html +4 -46
  306. nautobot/project-static/docs/development/core/controllers.html +4 -46
  307. nautobot/project-static/docs/development/core/docker-compose-advanced-use-cases.html +74 -73
  308. nautobot/project-static/docs/development/core/generic-views.html +4 -46
  309. nautobot/project-static/docs/development/core/getting-started.html +224 -249
  310. nautobot/project-static/docs/development/core/homepage.html +7 -49
  311. nautobot/project-static/docs/development/core/index.html +4 -46
  312. nautobot/project-static/docs/development/core/{minikube-dev-environment-for-k8s-jobs.html → local-k8s.html} +168 -469
  313. nautobot/project-static/docs/development/core/model-checklist.html +12 -56
  314. nautobot/project-static/docs/development/core/model-features.html +4 -46
  315. nautobot/project-static/docs/development/core/natural-keys.html +4 -46
  316. nautobot/project-static/docs/development/core/navigation-menu.html +4 -46
  317. nautobot/project-static/docs/development/core/release-checklist.html +7 -49
  318. nautobot/project-static/docs/development/core/role-internals.html +4 -46
  319. nautobot/project-static/docs/development/core/settings.html +4 -46
  320. nautobot/project-static/docs/development/core/style-guide.html +7 -49
  321. nautobot/project-static/docs/development/core/templates.html +4 -46
  322. nautobot/project-static/docs/development/core/testing.html +4 -46
  323. nautobot/project-static/docs/development/core/ui-component-framework.html +273 -369
  324. nautobot/project-static/docs/development/core/user-preferences.html +4 -46
  325. nautobot/project-static/docs/development/index.html +4 -46
  326. nautobot/project-static/docs/development/jobs/index.html +122 -216
  327. nautobot/project-static/docs/development/jobs/migration/from-v1.html +4 -46
  328. nautobot/project-static/docs/index.html +23 -54
  329. nautobot/project-static/docs/objects.inv +0 -0
  330. nautobot/project-static/docs/overview/application_stack.html +7 -47
  331. nautobot/project-static/docs/overview/design_philosophy.html +4 -46
  332. nautobot/project-static/docs/release-notes/index.html +12 -52
  333. nautobot/project-static/docs/release-notes/version-1.0.html +193 -234
  334. nautobot/project-static/docs/release-notes/version-1.1.html +190 -231
  335. nautobot/project-static/docs/release-notes/version-1.2.html +265 -306
  336. nautobot/project-static/docs/release-notes/version-1.3.html +291 -332
  337. nautobot/project-static/docs/release-notes/version-1.4.html +377 -417
  338. nautobot/project-static/docs/release-notes/version-1.5.html +566 -605
  339. nautobot/project-static/docs/release-notes/version-1.6.html +447 -904
  340. nautobot/project-static/docs/release-notes/version-2.0.html +489 -528
  341. nautobot/project-static/docs/release-notes/version-2.1.html +324 -363
  342. nautobot/project-static/docs/release-notes/version-2.2.html +317 -356
  343. nautobot/project-static/docs/release-notes/version-2.3.html +352 -997
  344. nautobot/project-static/docs/release-notes/version-2.4.html +101 -417
  345. nautobot/project-static/docs/requirements.txt +2 -2
  346. nautobot/project-static/docs/search/search_index.json +1 -1
  347. nautobot/project-static/docs/sitemap.xml +287 -295
  348. nautobot/project-static/docs/sitemap.xml.gz +0 -0
  349. nautobot/project-static/docs/user-guide/administration/configuration/authentication/ldap.html +4 -46
  350. nautobot/project-static/docs/user-guide/administration/configuration/authentication/remote.html +4 -46
  351. nautobot/project-static/docs/user-guide/administration/configuration/authentication/sso.html +6 -48
  352. nautobot/project-static/docs/user-guide/administration/configuration/index.html +4 -46
  353. nautobot/project-static/docs/user-guide/administration/configuration/redis.html +4 -46
  354. nautobot/project-static/docs/user-guide/administration/configuration/settings.html +8 -110
  355. nautobot/project-static/docs/user-guide/administration/configuration/time-zones.html +4 -46
  356. nautobot/project-static/docs/user-guide/administration/guides/celery-queues.html +4 -46
  357. nautobot/project-static/docs/user-guide/administration/guides/docker.html +4 -46
  358. nautobot/project-static/docs/user-guide/administration/guides/health-checks.html +4 -46
  359. nautobot/project-static/docs/user-guide/administration/guides/permissions.html +4 -46
  360. nautobot/project-static/docs/user-guide/administration/guides/prometheus-metrics.html +4 -46
  361. nautobot/project-static/docs/user-guide/administration/guides/replicating-nautobot.html +4 -46
  362. nautobot/project-static/docs/user-guide/administration/guides/request-profiling.html +4 -46
  363. nautobot/project-static/docs/user-guide/administration/guides/s3-django-storage.html +6 -48
  364. nautobot/project-static/docs/user-guide/administration/guides/selinux-troubleshooting.html +4 -46
  365. nautobot/project-static/docs/user-guide/administration/installation/app-install.html +4 -46
  366. nautobot/project-static/docs/user-guide/administration/installation/external-authentication.html +4 -46
  367. nautobot/project-static/docs/user-guide/administration/installation/http-server.html +8 -66
  368. nautobot/project-static/docs/user-guide/administration/installation/index.html +4 -46
  369. nautobot/project-static/docs/user-guide/administration/installation/install_system.html +5 -47
  370. nautobot/project-static/docs/user-guide/administration/installation/nautobot.html +4 -46
  371. nautobot/project-static/docs/user-guide/administration/installation/services.html +4 -46
  372. nautobot/project-static/docs/user-guide/administration/migration/migrating-from-netbox.html +4 -46
  373. nautobot/project-static/docs/user-guide/administration/migration/migrating-from-postgresql.html +4 -46
  374. nautobot/project-static/docs/user-guide/administration/tools/nautobot-server.html +4 -46
  375. nautobot/project-static/docs/user-guide/administration/tools/nautobot-shell.html +4 -46
  376. nautobot/project-static/docs/user-guide/administration/upgrading/database-backup.html +4 -46
  377. nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/ipam/after-you-upgrade.html +4 -46
  378. nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/ipam/before-you-upgrade.html +4 -46
  379. nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/ipam/for-developers.html +4 -46
  380. nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/ipam/index.html +4 -46
  381. nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/ipam/whats-changed.html +8 -49
  382. nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/region-and-site-data-migration-guide.html +4 -46
  383. nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/upgrading-from-nautobot-v1.html +4 -46
  384. nautobot/project-static/docs/user-guide/administration/upgrading/upgrading.html +4 -46
  385. nautobot/project-static/docs/user-guide/core-data-model/circuits/circuit.html +4 -46
  386. nautobot/project-static/docs/user-guide/core-data-model/circuits/circuittermination.html +4 -46
  387. nautobot/project-static/docs/user-guide/core-data-model/circuits/circuittype.html +4 -46
  388. nautobot/project-static/docs/user-guide/core-data-model/circuits/provider.html +4 -46
  389. nautobot/project-static/docs/user-guide/core-data-model/circuits/providernetwork.html +4 -46
  390. nautobot/project-static/docs/user-guide/core-data-model/cloud/cloud.html +4 -46
  391. nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudaccount.html +4 -46
  392. nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudnetwork.html +4 -46
  393. nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudnetworkprefixassignment.html +4 -46
  394. nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudresourcetype.html +4 -46
  395. nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudservice.html +4 -46
  396. nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudservicenetworkassignment.html +4 -46
  397. nautobot/project-static/docs/user-guide/core-data-model/dcim/cable.html +4 -46
  398. nautobot/project-static/docs/user-guide/core-data-model/dcim/consoleport.html +4 -46
  399. nautobot/project-static/docs/user-guide/core-data-model/dcim/consoleporttemplate.html +4 -46
  400. nautobot/project-static/docs/user-guide/core-data-model/dcim/consoleserverport.html +4 -46
  401. nautobot/project-static/docs/user-guide/core-data-model/dcim/consoleserverporttemplate.html +4 -46
  402. nautobot/project-static/docs/user-guide/core-data-model/dcim/controller.html +4 -46
  403. nautobot/project-static/docs/user-guide/core-data-model/dcim/controllermanageddevicegroup.html +4 -46
  404. nautobot/project-static/docs/user-guide/core-data-model/dcim/device.html +4 -46
  405. nautobot/project-static/docs/user-guide/core-data-model/dcim/devicebay.html +4 -46
  406. nautobot/project-static/docs/user-guide/core-data-model/dcim/devicebaytemplate.html +4 -46
  407. nautobot/project-static/docs/user-guide/core-data-model/dcim/devicefamily.html +4 -46
  408. nautobot/project-static/docs/user-guide/core-data-model/dcim/deviceredundancygroup.html +4 -46
  409. nautobot/project-static/docs/user-guide/core-data-model/dcim/devicetype.html +4 -46
  410. nautobot/project-static/docs/user-guide/core-data-model/dcim/frontport.html +4 -46
  411. nautobot/project-static/docs/user-guide/core-data-model/dcim/frontporttemplate.html +4 -46
  412. nautobot/project-static/docs/user-guide/core-data-model/dcim/interface.html +4 -46
  413. nautobot/project-static/docs/user-guide/core-data-model/dcim/interfaceredundancygroup.html +4 -46
  414. nautobot/project-static/docs/user-guide/core-data-model/dcim/interfacetemplate.html +4 -46
  415. nautobot/project-static/docs/user-guide/core-data-model/dcim/inventoryitem.html +4 -46
  416. nautobot/project-static/docs/user-guide/core-data-model/dcim/location.html +4 -46
  417. nautobot/project-static/docs/user-guide/core-data-model/dcim/locationtype.html +4 -46
  418. nautobot/project-static/docs/user-guide/core-data-model/dcim/manufacturer.html +4 -46
  419. nautobot/project-static/docs/user-guide/core-data-model/dcim/module.html +4 -46
  420. nautobot/project-static/docs/user-guide/core-data-model/dcim/modulebay.html +4 -46
  421. nautobot/project-static/docs/user-guide/core-data-model/dcim/modulebaytemplate.html +4 -46
  422. nautobot/project-static/docs/user-guide/core-data-model/dcim/moduletype.html +4 -46
  423. nautobot/project-static/docs/user-guide/core-data-model/dcim/platform.html +4 -46
  424. nautobot/project-static/docs/user-guide/core-data-model/dcim/powerfeed.html +4 -46
  425. nautobot/project-static/docs/user-guide/core-data-model/dcim/poweroutlet.html +4 -46
  426. nautobot/project-static/docs/user-guide/core-data-model/dcim/poweroutlettemplate.html +4 -46
  427. nautobot/project-static/docs/user-guide/core-data-model/dcim/powerpanel.html +4 -46
  428. nautobot/project-static/docs/user-guide/core-data-model/dcim/powerport.html +4 -46
  429. nautobot/project-static/docs/user-guide/core-data-model/dcim/powerporttemplate.html +4 -46
  430. nautobot/project-static/docs/user-guide/core-data-model/dcim/rack.html +4 -46
  431. nautobot/project-static/docs/user-guide/core-data-model/dcim/rackgroup.html +4 -46
  432. nautobot/project-static/docs/user-guide/core-data-model/dcim/rackreservation.html +4 -46
  433. nautobot/project-static/docs/user-guide/core-data-model/dcim/rearport.html +4 -46
  434. nautobot/project-static/docs/user-guide/core-data-model/dcim/rearporttemplate.html +4 -46
  435. nautobot/project-static/docs/user-guide/core-data-model/dcim/softwareimagefile.html +4 -46
  436. nautobot/project-static/docs/user-guide/core-data-model/dcim/softwareversion.html +4 -46
  437. nautobot/project-static/docs/user-guide/core-data-model/dcim/virtualchassis.html +4 -46
  438. nautobot/project-static/docs/user-guide/core-data-model/dcim/virtualdevicecontext.html +4 -46
  439. nautobot/project-static/docs/user-guide/core-data-model/extras/configcontext.html +12 -50
  440. nautobot/project-static/docs/user-guide/core-data-model/extras/configcontextschema.html +4 -46
  441. nautobot/project-static/docs/user-guide/core-data-model/extras/contact.html +4 -46
  442. nautobot/project-static/docs/user-guide/core-data-model/extras/team.html +4 -46
  443. nautobot/project-static/docs/user-guide/core-data-model/ipam/ipaddress.html +4 -46
  444. nautobot/project-static/docs/user-guide/core-data-model/ipam/namespace.html +4 -46
  445. nautobot/project-static/docs/user-guide/core-data-model/ipam/prefix.html +4 -46
  446. nautobot/project-static/docs/user-guide/core-data-model/ipam/rir.html +4 -46
  447. nautobot/project-static/docs/user-guide/core-data-model/ipam/routetarget.html +4 -46
  448. nautobot/project-static/docs/user-guide/core-data-model/ipam/service.html +4 -46
  449. nautobot/project-static/docs/user-guide/core-data-model/ipam/vlan.html +4 -46
  450. nautobot/project-static/docs/user-guide/core-data-model/ipam/vlangroup.html +4 -46
  451. nautobot/project-static/docs/user-guide/core-data-model/ipam/vrf.html +4 -46
  452. nautobot/project-static/docs/user-guide/core-data-model/overview/introduction.html +7 -49
  453. nautobot/project-static/docs/user-guide/core-data-model/tenancy/tenant.html +4 -46
  454. nautobot/project-static/docs/user-guide/core-data-model/tenancy/tenantgroup.html +4 -46
  455. nautobot/project-static/docs/user-guide/core-data-model/virtualization/cluster.html +4 -46
  456. nautobot/project-static/docs/user-guide/core-data-model/virtualization/clustergroup.html +4 -46
  457. nautobot/project-static/docs/user-guide/core-data-model/virtualization/clustertype.html +4 -46
  458. nautobot/project-static/docs/user-guide/core-data-model/virtualization/virtualmachine.html +4 -46
  459. nautobot/project-static/docs/user-guide/core-data-model/virtualization/vminterface.html +4 -46
  460. nautobot/project-static/docs/user-guide/core-data-model/wireless/index.html +4 -46
  461. nautobot/project-static/docs/user-guide/core-data-model/wireless/radioprofile.html +4 -46
  462. nautobot/project-static/docs/user-guide/core-data-model/wireless/supporteddatarate.html +4 -46
  463. nautobot/project-static/docs/user-guide/core-data-model/wireless/wirelessnetwork.html +4 -46
  464. nautobot/project-static/docs/user-guide/feature-guides/contacts-and-teams.html +4 -46
  465. nautobot/project-static/docs/user-guide/feature-guides/custom-fields.html +4 -46
  466. nautobot/project-static/docs/user-guide/feature-guides/getting-started/creating-devices.html +4 -46
  467. nautobot/project-static/docs/user-guide/feature-guides/getting-started/creating-location-types-and-locations.html +4 -46
  468. nautobot/project-static/docs/user-guide/feature-guides/getting-started/index.html +4 -46
  469. nautobot/project-static/docs/user-guide/feature-guides/getting-started/interfaces.html +4 -46
  470. nautobot/project-static/docs/user-guide/feature-guides/getting-started/ipam.html +4 -46
  471. nautobot/project-static/docs/user-guide/feature-guides/getting-started/platforms.html +4 -46
  472. nautobot/project-static/docs/user-guide/feature-guides/getting-started/search-bar.html +4 -46
  473. nautobot/project-static/docs/user-guide/feature-guides/getting-started/tenants.html +4 -46
  474. nautobot/project-static/docs/user-guide/feature-guides/getting-started/vlans-and-vlan-groups.html +4 -46
  475. nautobot/project-static/docs/user-guide/feature-guides/git-data-source.html +7 -51
  476. nautobot/project-static/docs/user-guide/feature-guides/graphql.html +4 -46
  477. nautobot/project-static/docs/user-guide/feature-guides/ip-address-merge-tool.html +4 -46
  478. nautobot/project-static/docs/user-guide/feature-guides/relationships.html +4 -46
  479. nautobot/project-static/docs/user-guide/feature-guides/software-image-files-and-versions.html +7 -49
  480. nautobot/project-static/docs/user-guide/index.html +4 -46
  481. nautobot/project-static/docs/user-guide/platform-functionality/change-logging.html +4 -46
  482. nautobot/project-static/docs/user-guide/platform-functionality/computedfield.html +8 -50
  483. nautobot/project-static/docs/user-guide/platform-functionality/customfield.html +4 -46
  484. nautobot/project-static/docs/user-guide/platform-functionality/customlink.html +4 -46
  485. nautobot/project-static/docs/user-guide/platform-functionality/dynamicgroup.html +4 -46
  486. nautobot/project-static/docs/user-guide/platform-functionality/events.html +4 -46
  487. nautobot/project-static/docs/user-guide/platform-functionality/exporttemplate.html +4 -46
  488. nautobot/project-static/docs/user-guide/platform-functionality/externalintegration.html +4 -46
  489. nautobot/project-static/docs/user-guide/platform-functionality/gitrepository.html +4 -46
  490. nautobot/project-static/docs/user-guide/platform-functionality/graphql.html +4 -46
  491. nautobot/project-static/docs/user-guide/platform-functionality/graphqlquery.html +4 -46
  492. nautobot/project-static/docs/user-guide/platform-functionality/imageattachment.html +4 -46
  493. nautobot/project-static/docs/user-guide/platform-functionality/jobs/index.html +7 -50
  494. nautobot/project-static/docs/user-guide/platform-functionality/jobs/job-scheduling-and-approvals.html +4 -46
  495. nautobot/project-static/docs/user-guide/platform-functionality/jobs/jobbutton.html +7 -49
  496. nautobot/project-static/docs/user-guide/platform-functionality/jobs/jobhook.html +4 -46
  497. nautobot/project-static/docs/user-guide/platform-functionality/jobs/jobqueue.html +4 -46
  498. nautobot/project-static/docs/user-guide/platform-functionality/jobs/models.html +4 -46
  499. nautobot/project-static/docs/user-guide/platform-functionality/napalm.html +4 -46
  500. nautobot/project-static/docs/user-guide/platform-functionality/note.html +4 -46
  501. nautobot/project-static/docs/user-guide/platform-functionality/objectmetadata.html +4 -46
  502. nautobot/project-static/docs/user-guide/platform-functionality/relationship.html +5 -47
  503. nautobot/project-static/docs/user-guide/platform-functionality/rendering-jinja-templates.html +4 -46
  504. nautobot/project-static/docs/user-guide/platform-functionality/rest-api/authentication.html +4 -46
  505. nautobot/project-static/docs/user-guide/platform-functionality/rest-api/filtering.html +25 -94
  506. nautobot/project-static/docs/user-guide/platform-functionality/rest-api/overview.html +5 -74
  507. nautobot/project-static/docs/user-guide/platform-functionality/rest-api/ui-related-endpoints.html +4 -46
  508. nautobot/project-static/docs/user-guide/platform-functionality/role.html +4 -46
  509. nautobot/project-static/docs/user-guide/platform-functionality/savedview.html +4 -46
  510. nautobot/project-static/docs/user-guide/platform-functionality/secret.html +4 -46
  511. nautobot/project-static/docs/user-guide/platform-functionality/staticgroupassociation.html +4 -46
  512. nautobot/project-static/docs/user-guide/platform-functionality/status.html +4 -46
  513. nautobot/project-static/docs/user-guide/platform-functionality/tag.html +4 -46
  514. nautobot/project-static/docs/user-guide/platform-functionality/template-filters.html +4 -46
  515. nautobot/project-static/docs/user-guide/platform-functionality/users/objectpermission.html +4 -46
  516. nautobot/project-static/docs/user-guide/platform-functionality/users/token.html +4 -46
  517. nautobot/project-static/docs/user-guide/platform-functionality/webhook.html +4 -46
  518. nautobot/project-static/js/forms.js +1 -1
  519. nautobot/tenancy/api/views.py +13 -9
  520. nautobot/tenancy/views.py +2 -4
  521. nautobot/users/admin.py +1 -1
  522. nautobot/users/api/serializers.py +4 -5
  523. nautobot/users/api/views.py +3 -3
  524. nautobot/virtualization/api/serializers.py +4 -4
  525. nautobot/virtualization/api/views.py +24 -5
  526. nautobot/virtualization/filters.py +3 -20
  527. nautobot/virtualization/models.py +1 -1
  528. nautobot/virtualization/tables.py +2 -2
  529. nautobot/virtualization/templates/virtualization/cluster_edit.html +7 -1
  530. nautobot/virtualization/templates/virtualization/virtualmachine.html +9 -1
  531. nautobot/virtualization/templates/virtualization/virtualmachine_edit.html +8 -2
  532. nautobot/virtualization/tests/test_filters.py +0 -17
  533. nautobot/wireless/filters.py +2 -2
  534. nautobot/wireless/forms.py +1 -1
  535. nautobot/wireless/templates/wireless/wirelessnetwork_retrieve.html +9 -1
  536. nautobot/wireless/tests/test_filters.py +1 -29
  537. nautobot/wireless/views.py +10 -0
  538. {nautobot-2.4.0.dist-info → nautobot-2.4.0b1.dist-info}/METADATA +6 -6
  539. {nautobot-2.4.0.dist-info → nautobot-2.4.0b1.dist-info}/RECORD +543 -591
  540. {nautobot-2.4.0.dist-info → nautobot-2.4.0b1.dist-info}/WHEEL +1 -1
  541. nautobot/core/api/constants.py +0 -11
  542. nautobot/core/jobs/bulk_actions.py +0 -248
  543. nautobot/core/templates/about.html +0 -67
  544. nautobot/core/templates/inc/tenancy_form_panel.html +0 -9
  545. nautobot/core/templates/inc/tenant_table_row.html +0 -11
  546. nautobot/core/utils/querysets.py +0 -64
  547. nautobot/dcim/migrations/0067_controllermanageddevicegroup_tenant.py +0 -25
  548. nautobot/dcim/tests/integration/test_controller.py +0 -62
  549. nautobot/dcim/tests/integration/test_controller_managed_device_group.py +0 -71
  550. nautobot/dcim/tests/test_jobs.py +0 -118
  551. nautobot/extras/migrations/0120_job_is_singleton_job_is_singleton_override.py +0 -22
  552. nautobot/extras/migrations/0121_alter_team_contacts.py +0 -17
  553. nautobot/extras/test_jobs/singleton.py +0 -16
  554. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_edit.png +0 -0
  555. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_edit_button.png +0 -0
  556. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_list_nav.png +0 -0
  557. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_list_view.png +0 -0
  558. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_queue.png +0 -0
  559. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_queue_add.png +0 -0
  560. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_queue_config.png +0 -0
  561. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_result_completed.png +0 -0
  562. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_result_nav.png +0 -0
  563. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_result_pending.png +0 -0
  564. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_run_form.png +0 -0
  565. nautobot/project-static/docs/media/development/core/kubernetes/k8s_nautobot_login.png +0 -0
  566. nautobot/project-static/docs/media/development/core/kubernetes/k8s_run_job.png +0 -0
  567. nautobot/project-static/docs/media/development/core/kubernetes/k8s_run_scheduled_job_form.png +0 -0
  568. nautobot/project-static/docs/media/development/core/kubernetes/k8s_scheduled_job_result.png +0 -0
  569. nautobot/project-static/docs/media/development/core/ui-component-framework/buttons-example.png +0 -0
  570. nautobot/project-static/docs/media/development/core/ui-component-framework/cluster-type-before-after-example.png +0 -0
  571. nautobot/project-static/docs/media/development/core/ui-component-framework/object-fields-panel-example_2.png +0 -0
  572. nautobot/project-static/docs/media/development/core/ui-component-framework/stats-panel-example-code.png +0 -0
  573. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/central-mode.png +0 -0
  574. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/device-group-add.png +0 -0
  575. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/device-group-create-1.png +0 -0
  576. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/device-group-create-2.png +0 -0
  577. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/radio-profile-add.png +0 -0
  578. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/radio-profile-create.png +0 -0
  579. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/supported-data-rate-add.png +0 -0
  580. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/supported-data-rate-create.png +0 -0
  581. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/wireless-controller-add.png +0 -0
  582. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/wireless-controller-create-1.png +0 -0
  583. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/wireless-controller-create-2.png +0 -0
  584. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/wireless-network-add.png +0 -0
  585. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/wireless-network-create.png +0 -0
  586. nautobot/project-static/docs/user-guide/feature-guides/wireless-networks-and-controllers.html +0 -9444
  587. nautobot/project-static/docs/user-guide/platform-functionality/jobs/kubernetes-job-support.html +0 -9722
  588. nautobot/wireless/tests/integration/__init__.py +0 -0
  589. nautobot/wireless/tests/integration/test_radio_profile.py +0 -42
  590. {nautobot-2.4.0.dist-info → nautobot-2.4.0b1.dist-info}/LICENSE.txt +0 -0
  591. {nautobot-2.4.0.dist-info → nautobot-2.4.0b1.dist-info}/NOTICE +0 -0
  592. {nautobot-2.4.0.dist-info → nautobot-2.4.0b1.dist-info}/entry_points.txt +0 -0
nautobot/project-static/docs/code-reference/nautobot/apps/ui.html CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
 
20
20
  <link rel="icon" href="../../../assets/favicon.ico">
21
- <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.49">
21
+ <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.46">
22
22
 
23
23
 
24
24
 
@@ -2112,27 +2112,6 @@
2112
2112
 
2113
2113
 
2114
2114
 
2115
-
2116
-
2117
-
2118
-
2119
-
2120
-
2121
- <li class="md-nav__item">
2122
- <a href="../../../user-guide/feature-guides/wireless-networks-and-controllers.html" class="md-nav__link">
2123
-
2124
-
2125
- <span class="md-ellipsis">
2126
- Wireless Networks and Controllers
2127
- </span>
2128
-
2129
-
2130
- </a>
2131
- </li>
2132
-
2133
-
2134
-
2135
-
2136
2115
  </ul>
2137
2116
  </nav>
2138
2117
 
@@ -5152,27 +5131,6 @@
5152
5131
 
5153
5132
 
5154
5133
 
5155
- <li class="md-nav__item">
5156
- <a href="../../../user-guide/platform-functionality/jobs/kubernetes-job-support.html" class="md-nav__link">
5157
-
5158
-
5159
- <span class="md-ellipsis">
5160
- Kubernetes Job Support
5161
- </span>
5162
-
5163
-
5164
- </a>
5165
- </li>
5166
-
5167
-
5168
-
5169
-
5170
-
5171
-
5172
-
5173
-
5174
-
5175
-
5176
5134
  <li class="md-nav__item">
5177
5135
  <a href="../../../user-guide/platform-functionality/jobs/jobbutton.html" class="md-nav__link">
5178
5136
 
@@ -9313,11 +9271,11 @@
9313
9271
 
9314
9272
 
9315
9273
  <li class="md-nav__item">
9316
- <a href="../../../development/core/minikube-dev-environment-for-k8s-jobs.html" class="md-nav__link">
9274
+ <a href="../../../development/core/local-k8s.html" class="md-nav__link">
9317
9275
 
9318
9276
 
9319
9277
  <span class="md-ellipsis">
9320
- Minikube Dev Environment for K8s Jobs
9278
+ Local Kubernetes Cluster
9321
9279
  </span>
9322
9280
 
9323
9281
 
@@ -11430,12 +11388,7 @@
11430
11388
 
11431
11389
  <div class="doc doc-contents first">
11432
11390
 
11433
- <p>Utilities for apps to integrate with and extend the existing Nautobot UI.</p>
11434
-
11435
-
11436
-
11437
-
11438
-
11391
+ <p>Utilities for apps to integrate with and extend the existing Nautobot UI.</p>
11439
11392
 
11440
11393
 
11441
11394
 
@@ -11462,12 +11415,7 @@
11462
11415
  <div class="doc doc-contents ">
11463
11416
 
11464
11417
 
11465
- <p>Class that may be returned by a registered plugin_banners function.</p>
11466
-
11467
-
11468
-
11469
-
11470
-
11418
+ <p>Class that may be returned by a registered plugin_banners function.</p>
11471
11419
 
11472
11420
 
11473
11421
 
@@ -11503,15 +11451,10 @@
11503
11451
 
11504
11452
  <div class="doc doc-contents ">
11505
11453
  <p class="doc doc-class-bases">
11506
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.choices.ChoiceSet" href="choices.html#nautobot.apps.choices.ChoiceSet">ChoiceSet</a></code></p>
11507
-
11508
-
11509
- <p>Styling choices for custom banners.</p>
11510
-
11511
-
11512
-
11454
+ Bases: <code><autoref identifier="nautobot.core.choices.ChoiceSet" optional hover>ChoiceSet</autoref></code></p>
11513
11455
 
11514
11456
 
11457
+ <p>Styling choices for custom banners.</p>
11515
11458
 
11516
11459
 
11517
11460
 
@@ -11547,15 +11490,10 @@
11547
11490
 
11548
11491
  <div class="doc doc-contents ">
11549
11492
  <p class="doc doc-class-bases">
11550
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.Panel" href="#nautobot.apps.ui.Panel">Panel</a></code></p>
11551
-
11552
-
11553
- <p>A panel that renders a single value as text, Markdown, JSON, or YAML.</p>
11554
-
11555
-
11556
-
11493
+ Bases: <code><autoref identifier="nautobot.core.ui.object_detail.Panel" optional hover>Panel</autoref></code></p>
11557
11494
 
11558
11495
 
11496
+ <p>A panel that renders a single value as text, Markdown, JSON, or YAML.</p>
11559
11497
 
11560
11498
 
11561
11499
 
@@ -11582,10 +11520,10 @@
11582
11520
 
11583
11521
  <div class="doc doc-contents ">
11584
11522
  <p class="doc doc-class-bases">
11585
- Bases: <code><span title="enum.Enum">Enum</span></code></p>
11523
+ Bases: <code><autoref identifier="enum.Enum" optional hover>Enum</autoref></code></p>
11586
11524
 
11587
11525
 
11588
- <p>Options available for text panels for different type of rendering a given input.</p>
11526
+ <p>Options available for text panels for different type of rendering a given input.</p>
11589
11527
 
11590
11528
 
11591
11529
  <p><span class="doc-section-title">Attributes:</span></p>
@@ -11599,9 +11537,9 @@
11599
11537
  </thead>
11600
11538
  <tbody>
11601
11539
  <tr class="doc-section-item">
11602
- <td><code><span title="nautobot.apps.ui.BaseTextPanel.RenderOptions.PLAINTEXT">PLAINTEXT</span></code></td>
11540
+ <td><code><autoref identifier="nautobot.apps.ui.BaseTextPanel.RenderOptions.PLAINTEXT" optional hover>PLAINTEXT</autoref></code></td>
11603
11541
  <td>
11604
- <code>str</code>
11542
+ <code><autoref identifier="str" optional>str</autoref></code>
11605
11543
  </td>
11606
11544
  <td>
11607
11545
  <div class="doc-md-description">
@@ -11610,9 +11548,9 @@
11610
11548
  </td>
11611
11549
  </tr>
11612
11550
  <tr class="doc-section-item">
11613
- <td><code><span title="nautobot.apps.ui.BaseTextPanel.RenderOptions.JSON">JSON</span></code></td>
11551
+ <td><code><autoref identifier="nautobot.apps.ui.BaseTextPanel.RenderOptions.JSON" optional hover>JSON</autoref></code></td>
11614
11552
  <td>
11615
- <code>str</code>
11553
+ <code><autoref identifier="str" optional>str</autoref></code>
11616
11554
  </td>
11617
11555
  <td>
11618
11556
  <div class="doc-md-description">
@@ -11621,9 +11559,9 @@
11621
11559
  </td>
11622
11560
  </tr>
11623
11561
  <tr class="doc-section-item">
11624
- <td><code><span title="nautobot.apps.ui.BaseTextPanel.RenderOptions.YAML">YAML</span></code></td>
11562
+ <td><code><autoref identifier="nautobot.apps.ui.BaseTextPanel.RenderOptions.YAML" optional hover>YAML</autoref></code></td>
11625
11563
  <td>
11626
- <code>str</code>
11564
+ <code><autoref identifier="str" optional>str</autoref></code>
11627
11565
  </td>
11628
11566
  <td>
11629
11567
  <div class="doc-md-description">
@@ -11632,9 +11570,9 @@
11632
11570
  </td>
11633
11571
  </tr>
11634
11572
  <tr class="doc-section-item">
11635
- <td><code><span title="nautobot.apps.ui.BaseTextPanel.RenderOptions.MARKDOWN">MARKDOWN</span></code></td>
11573
+ <td><code><autoref identifier="nautobot.apps.ui.BaseTextPanel.RenderOptions.MARKDOWN" optional hover>MARKDOWN</autoref></code></td>
11636
11574
  <td>
11637
- <code>str</code>
11575
+ <code><autoref identifier="str" optional>str</autoref></code>
11638
11576
  </td>
11639
11577
  <td>
11640
11578
  <div class="doc-md-description">
@@ -11643,9 +11581,9 @@
11643
11581
  </td>
11644
11582
  </tr>
11645
11583
  <tr class="doc-section-item">
11646
- <td><code><span title="nautobot.apps.ui.BaseTextPanel.RenderOptions.CODE">CODE</span></code></td>
11584
+ <td><code><autoref identifier="nautobot.apps.ui.BaseTextPanel.RenderOptions.CODE" optional hover>CODE</autoref></code></td>
11647
11585
  <td>
11648
- <code>str</code>
11586
+ <code><autoref identifier="str" optional>str</autoref></code>
11649
11587
  </td>
11650
11588
  <td>
11651
11589
  <div class="doc-md-description">
@@ -11659,11 +11597,6 @@
11659
11597
 
11660
11598
 
11661
11599
 
11662
-
11663
-
11664
-
11665
-
11666
-
11667
11600
  <div class="doc doc-children">
11668
11601
 
11669
11602
 
@@ -11694,7 +11627,7 @@
11694
11627
 
11695
11628
  <div class="doc doc-contents ">
11696
11629
 
11697
- <p>Instantiate BaseTextPanel.</p>
11630
+ <p>Instantiate BaseTextPanel.</p>
11698
11631
 
11699
11632
 
11700
11633
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -11709,11 +11642,9 @@
11709
11642
  </thead>
11710
11643
  <tbody>
11711
11644
  <tr class="doc-section-item">
11645
+ <td><code>render_as</code></td>
11712
11646
  <td>
11713
- <code>render_as</code>
11714
- </td>
11715
- <td>
11716
- <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.BaseTextPanel.RenderOptions" href="#nautobot.apps.ui.BaseTextPanel.RenderOptions">RenderOptions</a></code>
11647
+ <code><autoref identifier="nautobot.core.ui.object_detail.BaseTextPanel.RenderOptions" optional hover>RenderOptions</autoref></code>
11717
11648
  </td>
11718
11649
  <td>
11719
11650
  <div class="doc-md-description">
@@ -11721,15 +11652,13 @@
11721
11652
  </div>
11722
11653
  </td>
11723
11654
  <td>
11724
- <code><span title="nautobot.core.ui.object_detail.BaseTextPanel.RenderOptions.MARKDOWN">MARKDOWN</span></code>
11655
+ <code><autoref identifier="nautobot.core.ui.object_detail.BaseTextPanel.RenderOptions.MARKDOWN" optional hover>MARKDOWN</autoref></code>
11725
11656
  </td>
11726
11657
  </tr>
11727
11658
  <tr class="doc-section-item">
11659
+ <td><code>render_placeholder</code></td>
11728
11660
  <td>
11729
- <code>render_placeholder</code>
11730
- </td>
11731
- <td>
11732
- <code>bool</code>
11661
+ <code><autoref identifier="bool" optional>bool</autoref></code>
11733
11662
  </td>
11734
11663
  <td>
11735
11664
  <div class="doc-md-description">
@@ -11741,11 +11670,9 @@
11741
11670
  </td>
11742
11671
  </tr>
11743
11672
  <tr class="doc-section-item">
11673
+ <td><code>body_content_template_path</code></td>
11744
11674
  <td>
11745
- <code>body_content_template_path</code>
11746
- </td>
11747
- <td>
11748
- <code>str</code>
11675
+ <code><autoref identifier="str" optional>str</autoref></code>
11749
11676
  </td>
11750
11677
  <td>
11751
11678
  <div class="doc-md-description">
@@ -11758,11 +11685,9 @@ Can be overridden for custom use cases.</p>
11758
11685
  </td>
11759
11686
  </tr>
11760
11687
  <tr class="doc-section-item">
11688
+ <td><code>kwargs</code></td>
11761
11689
  <td>
11762
- <code>kwargs</code>
11763
- </td>
11764
- <td>
11765
- <code>dict</code>
11690
+ <code><autoref identifier="dict" optional>dict</autoref></code>
11766
11691
  </td>
11767
11692
  <td>
11768
11693
  <div class="doc-md-description">
@@ -11801,15 +11726,10 @@ Can be overridden for custom use cases.</p>
11801
11726
 
11802
11727
  <div class="doc doc-contents ">
11803
11728
  <p class="doc doc-class-bases">
11804
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.Component" href="#nautobot.apps.ui.Component">Component</a></code></p>
11805
-
11806
-
11807
- <p>Base class for UI framework definition of a single button within an Object Detail (Object Retrieve) page.</p>
11808
-
11809
-
11810
-
11729
+ Bases: <code><autoref identifier="nautobot.core.ui.object_detail.Component" optional hover>Component</autoref></code></p>
11811
11730
 
11812
11731
 
11732
+ <p>Base class for UI framework definition of a single button within an Object Detail (Object Retrieve) page.</p>
11813
11733
 
11814
11734
 
11815
11735
 
@@ -11835,7 +11755,7 @@ Can be overridden for custom use cases.</p>
11835
11755
 
11836
11756
  <div class="doc doc-contents ">
11837
11757
 
11838
- <p>Initialize a Button component.</p>
11758
+ <p>Initialize a Button component.</p>
11839
11759
 
11840
11760
 
11841
11761
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -11850,11 +11770,9 @@ Can be overridden for custom use cases.</p>
11850
11770
  </thead>
11851
11771
  <tbody>
11852
11772
  <tr class="doc-section-item">
11773
+ <td><code>label</code></td>
11853
11774
  <td>
11854
- <code>label</code>
11855
- </td>
11856
- <td>
11857
- <code>str</code>
11775
+ <code><autoref identifier="str" optional>str</autoref></code>
11858
11776
  </td>
11859
11777
  <td>
11860
11778
  <div class="doc-md-description">
@@ -11866,11 +11784,9 @@ Can be overridden for custom use cases.</p>
11866
11784
  </td>
11867
11785
  </tr>
11868
11786
  <tr class="doc-section-item">
11787
+ <td><code>color</code></td>
11869
11788
  <td>
11870
- <code>color</code>
11871
- </td>
11872
- <td>
11873
- <code><a class="autorefs autorefs-internal" title="nautobot.core.choices.ButtonColorChoices" href="#nautobot.apps.ui.ButtonColorChoices">ButtonColorChoices</a></code>
11789
+ <code><autoref identifier="nautobot.core.choices.ButtonColorChoices" optional hover>ButtonColorChoices</autoref></code>
11874
11790
  </td>
11875
11791
  <td>
11876
11792
  <div class="doc-md-description">
@@ -11878,15 +11794,13 @@ Can be overridden for custom use cases.</p>
11878
11794
  </div>
11879
11795
  </td>
11880
11796
  <td>
11881
- <code><span title="nautobot.core.choices.ButtonColorChoices.DEFAULT">DEFAULT</span></code>
11797
+ <code><autoref identifier="nautobot.core.choices.ButtonColorChoices.DEFAULT" optional hover>DEFAULT</autoref></code>
11882
11798
  </td>
11883
11799
  </tr>
11884
11800
  <tr class="doc-section-item">
11801
+ <td><code>link_name</code></td>
11885
11802
  <td>
11886
- <code>link_name</code>
11887
- </td>
11888
- <td>
11889
- <code>str</code>
11803
+ <code><autoref identifier="str" optional>str</autoref></code>
11890
11804
  </td>
11891
11805
  <td>
11892
11806
  <div class="doc-md-description">
@@ -11901,11 +11815,9 @@ and override the <code>get_link()</code> method.</p>
11901
11815
  </td>
11902
11816
  </tr>
11903
11817
  <tr class="doc-section-item">
11818
+ <td><code>icon</code></td>
11904
11819
  <td>
11905
- <code>icon</code>
11906
- </td>
11907
- <td>
11908
- <code>str</code>
11820
+ <code><autoref identifier="str" optional>str</autoref></code>
11909
11821
  </td>
11910
11822
  <td>
11911
11823
  <div class="doc-md-description">
@@ -11917,11 +11829,9 @@ and override the <code>get_link()</code> method.</p>
11917
11829
  </td>
11918
11830
  </tr>
11919
11831
  <tr class="doc-section-item">
11832
+ <td><code>template_path</code></td>
11920
11833
  <td>
11921
- <code>template_path</code>
11922
- </td>
11923
- <td>
11924
- <code>str</code>
11834
+ <code><autoref identifier="str" optional>str</autoref></code>
11925
11835
  </td>
11926
11836
  <td>
11927
11837
  <div class="doc-md-description">
@@ -11933,11 +11843,9 @@ and override the <code>get_link()</code> method.</p>
11933
11843
  </td>
11934
11844
  </tr>
11935
11845
  <tr class="doc-section-item">
11846
+ <td><code>required_permissions</code></td>
11936
11847
  <td>
11937
- <code>required_permissions</code>
11938
- </td>
11939
- <td>
11940
- <code>list</code>
11848
+ <code><autoref identifier="list" optional>list</autoref></code>
11941
11849
  </td>
11942
11850
  <td>
11943
11851
  <div class="doc-md-description">
@@ -11950,11 +11858,9 @@ The button will only be rendered if the user has these permissions.</p>
11950
11858
  </td>
11951
11859
  </tr>
11952
11860
  <tr class="doc-section-item">
11861
+ <td><code>javascript_template_path</code></td>
11953
11862
  <td>
11954
- <code>javascript_template_path</code>
11955
- </td>
11956
- <td>
11957
- <code>str</code>
11863
+ <code><autoref identifier="str" optional>str</autoref></code>
11958
11864
  </td>
11959
11865
  <td>
11960
11866
  <div class="doc-md-description">
@@ -11967,11 +11873,9 @@ Does not need to include the wrapping <code>&lt;script&gt;...&lt;/script&gt;</co
11967
11873
  </td>
11968
11874
  </tr>
11969
11875
  <tr class="doc-section-item">
11876
+ <td><code>attributes</code></td>
11970
11877
  <td>
11971
- <code>attributes</code>
11972
- </td>
11973
- <td>
11974
- <code>dict</code>
11878
+ <code><autoref identifier="dict" optional>dict</autoref></code>
11975
11879
  </td>
11976
11880
  <td>
11977
11881
  <div class="doc-md-description">
@@ -12000,7 +11904,7 @@ Does not need to include the wrapping <code>&lt;script&gt;...&lt;/script&gt;</co
12000
11904
 
12001
11905
  <div class="doc doc-contents ">
12002
11906
 
12003
- <p>Add the relevant attributes of this Button to the context.</p>
11907
+ <p>Add the relevant attributes of this Button to the context.</p>
12004
11908
 
12005
11909
  </div>
12006
11910
 
@@ -12017,7 +11921,7 @@ Does not need to include the wrapping <code>&lt;script&gt;...&lt;/script&gt;</co
12017
11921
 
12018
11922
  <div class="doc doc-contents ">
12019
11923
 
12020
- <p>Get the hyperlink URL (if any) for this button.</p>
11924
+ <p>Get the hyperlink URL (if any) for this button.</p>
12021
11925
  <p>Defaults to reversing <code>self.link_name</code> with <code>pk: obj.pk</code> as a kwarg, but subclasses may override this for
12022
11926
  more advanced link construction.</p>
12023
11927
 
@@ -12036,7 +11940,7 @@ more advanced link construction.</p>
12036
11940
 
12037
11941
  <div class="doc doc-contents ">
12038
11942
 
12039
- <p>Render this button to HTML, possibly including any associated JavaScript.</p>
11943
+ <p>Render this button to HTML, possibly including any associated JavaScript.</p>
12040
11944
 
12041
11945
  </div>
12042
11946
 
@@ -12053,7 +11957,7 @@ more advanced link construction.</p>
12053
11957
 
12054
11958
  <div class="doc doc-contents ">
12055
11959
 
12056
- <p>Render if and only if the requesting user has appropriate permissions (if any).</p>
11960
+ <p>Render if and only if the requesting user has appropriate permissions (if any).</p>
12057
11961
 
12058
11962
  </div>
12059
11963
 
@@ -12080,15 +11984,10 @@ more advanced link construction.</p>
12080
11984
 
12081
11985
  <div class="doc doc-contents ">
12082
11986
  <p class="doc doc-class-bases">
12083
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.choices.ChoiceSet" href="choices.html#nautobot.apps.choices.ChoiceSet">ChoiceSet</a></code></p>
12084
-
12085
-
12086
- <p>Map standard button color choices to Bootstrap color classes</p>
12087
-
12088
-
12089
-
11987
+ Bases: <code><autoref identifier="nautobot.core.choices.ChoiceSet" optional hover>ChoiceSet</autoref></code></p>
12090
11988
 
12091
11989
 
11990
+ <p>Map standard button color choices to Bootstrap color classes</p>
12092
11991
 
12093
11992
 
12094
11993
 
@@ -12125,12 +12024,7 @@ more advanced link construction.</p>
12125
12024
  <div class="doc doc-contents ">
12126
12025
 
12127
12026
 
12128
- <p>Common base class for renderable components (tabs, panels, etc.).</p>
12129
-
12130
-
12131
-
12132
-
12133
-
12027
+ <p>Common base class for renderable components (tabs, panels, etc.).</p>
12134
12028
 
12135
12029
 
12136
12030
 
@@ -12156,7 +12050,7 @@ more advanced link construction.</p>
12156
12050
 
12157
12051
  <div class="doc doc-contents ">
12158
12052
 
12159
- <p>Initialize common Component properties.</p>
12053
+ <p>Initialize common Component properties.</p>
12160
12054
 
12161
12055
 
12162
12056
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -12171,11 +12065,9 @@ more advanced link construction.</p>
12171
12065
  </thead>
12172
12066
  <tbody>
12173
12067
  <tr class="doc-section-item">
12068
+ <td><code>weight</code></td>
12174
12069
  <td>
12175
- <code>weight</code>
12176
- </td>
12177
- <td>
12178
- <code>int</code>
12070
+ <code><autoref identifier="int" optional>int</autoref></code>
12179
12071
  </td>
12180
12072
  <td>
12181
12073
  <div class="doc-md-description">
@@ -12205,7 +12097,7 @@ rendered "first", usually towards the top left of the page.</p>
12205
12097
 
12206
12098
  <div class="doc doc-contents ">
12207
12099
 
12208
- <p>Provide additional data to include in the rendering context, based on the configuration of this component.</p>
12100
+ <p>Provide additional data to include in the rendering context, based on the configuration of this component.</p>
12209
12101
 
12210
12102
 
12211
12103
  <p><span class="doc-section-title">Returns:</span></p>
@@ -12219,7 +12111,7 @@ rendered "first", usually towards the top left of the page.</p>
12219
12111
  <tbody>
12220
12112
  <tr class="doc-section-item">
12221
12113
  <td>
12222
- <code>dict</code>
12114
+ <code><autoref identifier="dict" optional>dict</autoref></code>
12223
12115
  </td>
12224
12116
  <td>
12225
12117
  <div class="doc-md-description">
@@ -12245,7 +12137,7 @@ rendered "first", usually towards the top left of the page.</p>
12245
12137
 
12246
12138
  <div class="doc doc-contents ">
12247
12139
 
12248
- <p>Render this component to HTML.</p>
12140
+ <p>Render this component to HTML.</p>
12249
12141
  <p>Note that not all Components are fully or solely rendered by their <code>render()</code> method alone, for example,
12250
12142
  a Tab has a separate "label" that must be rendered by calling its <code>render_label_wrapper()</code> API instead.</p>
12251
12143
 
@@ -12261,7 +12153,7 @@ a Tab has a separate "label" that must be rendered by calling its <code>render_l
12261
12153
  <tbody>
12262
12154
  <tr class="doc-section-item">
12263
12155
  <td>
12264
- <code>str</code>
12156
+ <code><autoref identifier="str" optional>str</autoref></code>
12265
12157
  </td>
12266
12158
  <td>
12267
12159
  <div class="doc-md-description">
@@ -12287,7 +12179,7 @@ a Tab has a separate "label" that must be rendered by calling its <code>render_l
12287
12179
 
12288
12180
  <div class="doc doc-contents ">
12289
12181
 
12290
- <p>Check whether this component should be rendered at all.</p>
12182
+ <p>Check whether this component should be rendered at all.</p>
12291
12183
  <p>This API is designed to provide "short-circuit" logic for skipping what otherwise might be expensive rendering.
12292
12184
  In general most Components may also return an empty string when actually rendered, which is typically also a
12293
12185
  means to specify that they do not need to be rendered, but may be more expensive to derive.</p>
@@ -12304,7 +12196,7 @@ means to specify that they do not need to be rendered, but may be more expensive
12304
12196
  <tbody>
12305
12197
  <tr class="doc-section-item">
12306
12198
  <td>
12307
- <code>bool</code>
12199
+ <code><autoref identifier="bool" optional>bool</autoref></code>
12308
12200
  </td>
12309
12201
  <td>
12310
12202
  <div class="doc-md-description">
@@ -12340,15 +12232,10 @@ means to specify that they do not need to be rendered, but may be more expensive
12340
12232
 
12341
12233
  <div class="doc doc-contents ">
12342
12234
  <p class="doc doc-class-bases">
12343
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.Panel" href="#nautobot.apps.ui.Panel">Panel</a></code></p>
12344
-
12345
-
12346
- <p>A panel that renders a table generated directly from a list of dicts, without using a django_tables2 Table class.</p>
12347
-
12348
-
12349
-
12235
+ Bases: <code><autoref identifier="nautobot.core.ui.object_detail.Panel" optional hover>Panel</autoref></code></p>
12350
12236
 
12351
12237
 
12238
+ <p>A panel that renders a table generated directly from a list of dicts, without using a django_tables2 Table class.</p>
12352
12239
 
12353
12240
 
12354
12241
 
@@ -12374,7 +12261,7 @@ means to specify that they do not need to be rendered, but may be more expensive
12374
12261
 
12375
12262
  <div class="doc doc-contents ">
12376
12263
 
12377
- <p>Instantiate a DataDictTablePanel.</p>
12264
+ <p>Instantiate a DataDictTablePanel.</p>
12378
12265
 
12379
12266
 
12380
12267
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -12389,11 +12276,9 @@ means to specify that they do not need to be rendered, but may be more expensive
12389
12276
  </thead>
12390
12277
  <tbody>
12391
12278
  <tr class="doc-section-item">
12279
+ <td><code>context_data_key</code></td>
12392
12280
  <td>
12393
- <code>context_data_key</code>
12394
- </td>
12395
- <td>
12396
- <code>str</code>
12281
+ <code><autoref identifier="str" optional>str</autoref></code>
12397
12282
  </td>
12398
12283
  <td>
12399
12284
  <div class="doc-md-description">
@@ -12405,11 +12290,9 @@ means to specify that they do not need to be rendered, but may be more expensive
12405
12290
  </td>
12406
12291
  </tr>
12407
12292
  <tr class="doc-section-item">
12293
+ <td><code>columns</code></td>
12408
12294
  <td>
12409
- <code>columns</code>
12410
- </td>
12411
- <td>
12412
- <code>list</code>
12295
+ <code><autoref identifier="list" optional>list</autoref></code>
12413
12296
  </td>
12414
12297
  <td>
12415
12298
  <div class="doc-md-description">
@@ -12423,11 +12306,9 @@ If neither are specified, the keys of the first dict in the data will be used.</
12423
12306
  </td>
12424
12307
  </tr>
12425
12308
  <tr class="doc-section-item">
12309
+ <td><code>context_columns_key</code></td>
12426
12310
  <td>
12427
- <code>context_columns_key</code>
12428
- </td>
12429
- <td>
12430
- <code>str</code>
12311
+ <code><autoref identifier="str" optional>str</autoref></code>
12431
12312
  </td>
12432
12313
  <td>
12433
12314
  <div class="doc-md-description">
@@ -12441,11 +12322,9 @@ If neither are specified, the keys of the first dict in the data will be used.</
12441
12322
  </td>
12442
12323
  </tr>
12443
12324
  <tr class="doc-section-item">
12325
+ <td><code>column_headers</code></td>
12444
12326
  <td>
12445
- <code>column_headers</code>
12446
- </td>
12447
- <td>
12448
- <code>list</code>
12327
+ <code><autoref identifier="list" optional>list</autoref></code>
12449
12328
  </td>
12450
12329
  <td>
12451
12330
  <div class="doc-md-description">
@@ -12458,11 +12337,9 @@ Mutually exclusive with <code>context_column_headers_key</code>.</p>
12458
12337
  </td>
12459
12338
  </tr>
12460
12339
  <tr class="doc-section-item">
12340
+ <td><code>context_column_headers_key</code></td>
12461
12341
  <td>
12462
- <code>context_column_headers_key</code>
12463
- </td>
12464
- <td>
12465
- <code>str</code>
12342
+ <code><autoref identifier="str" optional>str</autoref></code>
12466
12343
  </td>
12467
12344
  <td>
12468
12345
  <div class="doc-md-description">
@@ -12502,15 +12379,10 @@ Mutually exclusive with <code>column_headers</code>.</p>
12502
12379
 
12503
12380
  <div class="doc doc-contents ">
12504
12381
  <p class="doc doc-class-bases">
12505
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.Tab" href="#nautobot.apps.ui.Tab">Tab</a></code></p>
12506
-
12507
-
12508
- <p>A Tab that doesn't render inline on the same page, but instead links to a distinct view of its own when clicked.</p>
12509
-
12510
-
12511
-
12382
+ Bases: <code><autoref identifier="nautobot.core.ui.object_detail.Tab" optional hover>Tab</autoref></code></p>
12512
12383
 
12513
12384
 
12385
+ <p>A Tab that doesn't render inline on the same page, but instead links to a distinct view of its own when clicked.</p>
12514
12386
 
12515
12387
 
12516
12388
 
@@ -12546,15 +12418,10 @@ Mutually exclusive with <code>column_headers</code>.</p>
12546
12418
 
12547
12419
  <div class="doc doc-contents ">
12548
12420
  <p class="doc doc-class-bases">
12549
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.Button" href="#nautobot.apps.ui.Button">Button</a></code></p>
12550
-
12551
-
12552
- <p>A Button that has one or more other buttons as <code>children</code>, which it renders into a dropdown menu.</p>
12553
-
12554
-
12555
-
12421
+ Bases: <code><autoref identifier="nautobot.core.ui.object_detail.Button" optional hover>Button</autoref></code></p>
12556
12422
 
12557
12423
 
12424
+ <p>A Button that has one or more other buttons as <code>children</code>, which it renders into a dropdown menu.</p>
12558
12425
 
12559
12426
 
12560
12427
 
@@ -12580,7 +12447,7 @@ Mutually exclusive with <code>column_headers</code>.</p>
12580
12447
 
12581
12448
  <div class="doc doc-contents ">
12582
12449
 
12583
- <p>Initialize a DropdownButton component.</p>
12450
+ <p>Initialize a DropdownButton component.</p>
12584
12451
 
12585
12452
 
12586
12453
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -12595,11 +12462,9 @@ Mutually exclusive with <code>column_headers</code>.</p>
12595
12462
  </thead>
12596
12463
  <tbody>
12597
12464
  <tr class="doc-section-item">
12465
+ <td><code>children</code></td>
12598
12466
  <td>
12599
- <code>children</code>
12600
- </td>
12601
- <td>
12602
- <code>list[<a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.Button" href="#nautobot.apps.ui.Button">Button</a>]</code>
12467
+ <code><autoref identifier="list" optional>list</autoref>[<autoref identifier="nautobot.core.ui.object_detail.Button" optional hover>Button</autoref>]</code>
12603
12468
  </td>
12604
12469
  <td>
12605
12470
  <div class="doc-md-description">
@@ -12611,11 +12476,9 @@ Mutually exclusive with <code>column_headers</code>.</p>
12611
12476
  </td>
12612
12477
  </tr>
12613
12478
  <tr class="doc-section-item">
12479
+ <td><code>template_path</code></td>
12614
12480
  <td>
12615
- <code>template_path</code>
12616
- </td>
12617
- <td>
12618
- <code>str</code>
12481
+ <code><autoref identifier="str" optional>str</autoref></code>
12619
12482
  </td>
12620
12483
  <td>
12621
12484
  <div class="doc-md-description">
@@ -12644,7 +12507,7 @@ Mutually exclusive with <code>column_headers</code>.</p>
12644
12507
 
12645
12508
  <div class="doc doc-contents ">
12646
12509
 
12647
- <p>Add the children of this DropdownButton to the other Button context.</p>
12510
+ <p>Add the children of this DropdownButton to the other Button context.</p>
12648
12511
 
12649
12512
  </div>
12650
12513
 
@@ -12671,21 +12534,16 @@ Mutually exclusive with <code>column_headers</code>.</p>
12671
12534
 
12672
12535
  <div class="doc doc-contents ">
12673
12536
  <p class="doc doc-class-bases">
12674
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.KeyValueTablePanel" href="#nautobot.apps.ui.KeyValueTablePanel">KeyValueTablePanel</a></code></p>
12537
+ Bases: <code><autoref identifier="nautobot.core.ui.object_detail.KeyValueTablePanel" optional hover>KeyValueTablePanel</autoref></code></p>
12675
12538
 
12676
12539
 
12677
- <p>A KeyValueTablePanel that displays its data within collapsible accordion groupings, such as object custom fields.</p>
12540
+ <p>A KeyValueTablePanel that displays its data within collapsible accordion groupings, such as object custom fields.</p>
12678
12541
  <p>Expects data in the form <code>{grouping1: {key1: value1, key2: value2, ...}, grouping2: {...}, ...}</code>.</p>
12679
12542
  <p>The special grouping <code>""</code> may be used to indicate top-level key/value pairs that don't belong to a group.</p>
12680
12543
 
12681
12544
 
12682
12545
 
12683
12546
 
12684
-
12685
-
12686
-
12687
-
12688
-
12689
12547
  <div class="doc doc-children">
12690
12548
 
12691
12549
 
@@ -12707,7 +12565,7 @@ Mutually exclusive with <code>column_headers</code>.</p>
12707
12565
 
12708
12566
  <div class="doc doc-contents ">
12709
12567
 
12710
- <p>Render groups of key-value pairs to HTML.</p>
12568
+ <p>Render groups of key-value pairs to HTML.</p>
12711
12569
 
12712
12570
  </div>
12713
12571
 
@@ -12724,7 +12582,7 @@ Mutually exclusive with <code>column_headers</code>.</p>
12724
12582
 
12725
12583
  <div class="doc doc-contents ">
12726
12584
 
12727
- <p>Add a "Collapse All" button to the header.</p>
12585
+ <p>Add a "Collapse All" button to the header.</p>
12728
12586
 
12729
12587
  </div>
12730
12588
 
@@ -12751,15 +12609,10 @@ Mutually exclusive with <code>column_headers</code>.</p>
12751
12609
 
12752
12610
  <div class="doc doc-contents ">
12753
12611
  <p class="doc doc-class-bases">
12754
- Bases: <code><span title="abc.ABC">ABC</span></code></p>
12755
-
12756
-
12757
- <p>Base class for homepage layout classes.</p>
12758
-
12759
-
12760
-
12612
+ Bases: <code><autoref identifier="abc.ABC" optional hover>ABC</autoref></code></p>
12761
12613
 
12762
12614
 
12615
+ <p>Base class for homepage layout classes.</p>
12763
12616
 
12764
12617
 
12765
12618
 
@@ -12795,15 +12648,10 @@ Mutually exclusive with <code>column_headers</code>.</p>
12795
12648
 
12796
12649
  <div class="doc doc-contents ">
12797
12650
  <p class="doc doc-class-bases">
12798
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.homepage.HomePageBase" href="#nautobot.apps.ui.HomePageBase">HomePageBase</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.base.PermissionsMixin" href="#nautobot.apps.ui.PermissionsMixin">PermissionsMixin</a></code></p>
12799
-
12800
-
12801
- <p>Defines properties that can be used for a panel group.</p>
12802
-
12803
-
12804
-
12651
+ Bases: <code><autoref identifier="nautobot.core.ui.homepage.HomePageBase" optional hover>HomePageBase</autoref></code>, <code><autoref identifier="nautobot.core.ui.base.PermissionsMixin" optional hover>PermissionsMixin</autoref></code></p>
12805
12652
 
12806
12653
 
12654
+ <p>Defines properties that can be used for a panel group.</p>
12807
12655
 
12808
12656
 
12809
12657
 
@@ -12829,7 +12677,7 @@ Mutually exclusive with <code>column_headers</code>.</p>
12829
12677
 
12830
12678
  <div class="doc doc-contents ">
12831
12679
 
12832
- <p>Ensure group properties.</p>
12680
+ <p>Ensure group properties.</p>
12833
12681
 
12834
12682
 
12835
12683
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -12844,11 +12692,9 @@ Mutually exclusive with <code>column_headers</code>.</p>
12844
12692
  </thead>
12845
12693
  <tbody>
12846
12694
  <tr class="doc-section-item">
12695
+ <td><code>name</code></td>
12847
12696
  <td>
12848
- <code>name</code>
12849
- </td>
12850
- <td>
12851
- <code>str</code>
12697
+ <code><autoref identifier="str" optional>str</autoref></code>
12852
12698
  </td>
12853
12699
  <td>
12854
12700
  <div class="doc-md-description">
@@ -12860,11 +12706,9 @@ Mutually exclusive with <code>column_headers</code>.</p>
12860
12706
  </td>
12861
12707
  </tr>
12862
12708
  <tr class="doc-section-item">
12709
+ <td><code>permissions</code></td>
12863
12710
  <td>
12864
- <code>permissions</code>
12865
- </td>
12866
- <td>
12867
- <code>list</code>
12711
+ <code><autoref identifier="list" optional>list</autoref></code>
12868
12712
  </td>
12869
12713
  <td>
12870
12714
  <div class="doc-md-description">
@@ -12876,11 +12720,9 @@ Mutually exclusive with <code>column_headers</code>.</p>
12876
12720
  </td>
12877
12721
  </tr>
12878
12722
  <tr class="doc-section-item">
12723
+ <td><code>items</code></td>
12879
12724
  <td>
12880
- <code>items</code>
12881
- </td>
12882
- <td>
12883
- <code>list</code>
12725
+ <code><autoref identifier="list" optional>list</autoref></code>
12884
12726
  </td>
12885
12727
  <td>
12886
12728
  <div class="doc-md-description">
@@ -12892,11 +12734,9 @@ Mutually exclusive with <code>column_headers</code>.</p>
12892
12734
  </td>
12893
12735
  </tr>
12894
12736
  <tr class="doc-section-item">
12737
+ <td><code>weight</code></td>
12895
12738
  <td>
12896
- <code>weight</code>
12897
- </td>
12898
- <td>
12899
- <code>int</code>
12739
+ <code><autoref identifier="int" optional>int</autoref></code>
12900
12740
  </td>
12901
12741
  <td>
12902
12742
  <div class="doc-md-description">
@@ -12935,15 +12775,10 @@ Mutually exclusive with <code>column_headers</code>.</p>
12935
12775
 
12936
12776
  <div class="doc doc-contents ">
12937
12777
  <p class="doc doc-class-bases">
12938
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.homepage.HomePageBase" href="#nautobot.apps.ui.HomePageBase">HomePageBase</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.base.PermissionsMixin" href="#nautobot.apps.ui.PermissionsMixin">PermissionsMixin</a></code></p>
12939
-
12940
-
12941
- <p>Defines properties that can be used for a panel item.</p>
12942
-
12943
-
12944
-
12778
+ Bases: <code><autoref identifier="nautobot.core.ui.homepage.HomePageBase" optional hover>HomePageBase</autoref></code>, <code><autoref identifier="nautobot.core.ui.base.PermissionsMixin" optional hover>PermissionsMixin</autoref></code></p>
12945
12779
 
12946
12780
 
12781
+ <p>Defines properties that can be used for a panel item.</p>
12947
12782
 
12948
12783
 
12949
12784
 
@@ -12969,7 +12804,7 @@ Mutually exclusive with <code>column_headers</code>.</p>
12969
12804
 
12970
12805
  <div class="doc doc-contents ">
12971
12806
 
12972
- <p>Ensure item properties.</p>
12807
+ <p>Ensure item properties.</p>
12973
12808
 
12974
12809
 
12975
12810
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -12984,11 +12819,9 @@ Mutually exclusive with <code>column_headers</code>.</p>
12984
12819
  </thead>
12985
12820
  <tbody>
12986
12821
  <tr class="doc-section-item">
12822
+ <td><code>name</code></td>
12987
12823
  <td>
12988
- <code>name</code>
12989
- </td>
12990
- <td>
12991
- <code>str</code>
12824
+ <code><autoref identifier="str" optional>str</autoref></code>
12992
12825
  </td>
12993
12826
  <td>
12994
12827
  <div class="doc-md-description">
@@ -13000,11 +12833,9 @@ Mutually exclusive with <code>column_headers</code>.</p>
13000
12833
  </td>
13001
12834
  </tr>
13002
12835
  <tr class="doc-section-item">
12836
+ <td><code>link</code></td>
13003
12837
  <td>
13004
- <code>link</code>
13005
- </td>
13006
- <td>
13007
- <code>str</code>
12838
+ <code><autoref identifier="str" optional>str</autoref></code>
13008
12839
  </td>
13009
12840
  <td>
13010
12841
  <div class="doc-md-description">
@@ -13016,11 +12847,9 @@ Mutually exclusive with <code>column_headers</code>.</p>
13016
12847
  </td>
13017
12848
  </tr>
13018
12849
  <tr class="doc-section-item">
12850
+ <td><code>model</code></td>
13019
12851
  <td>
13020
- <code>model</code>
13021
- </td>
13022
- <td>
13023
- <code>str</code>
12852
+ <code><autoref identifier="str" optional>str</autoref></code>
13024
12853
  </td>
13025
12854
  <td>
13026
12855
  <div class="doc-md-description">
@@ -13032,11 +12861,9 @@ Mutually exclusive with <code>column_headers</code>.</p>
13032
12861
  </td>
13033
12862
  </tr>
13034
12863
  <tr class="doc-section-item">
12864
+ <td><code>custom_template</code></td>
13035
12865
  <td>
13036
- <code>custom_template</code>
13037
- </td>
13038
- <td>
13039
- <code>str</code>
12866
+ <code><autoref identifier="str" optional>str</autoref></code>
13040
12867
  </td>
13041
12868
  <td>
13042
12869
  <div class="doc-md-description">
@@ -13048,11 +12875,9 @@ Mutually exclusive with <code>column_headers</code>.</p>
13048
12875
  </td>
13049
12876
  </tr>
13050
12877
  <tr class="doc-section-item">
12878
+ <td><code>custom_data</code></td>
13051
12879
  <td>
13052
- <code>custom_data</code>
13053
- </td>
13054
- <td>
13055
- <code>dict</code>
12880
+ <code><autoref identifier="dict" optional>dict</autoref></code>
13056
12881
  </td>
13057
12882
  <td>
13058
12883
  <div class="doc-md-description">
@@ -13091,15 +12916,10 @@ Mutually exclusive with <code>column_headers</code>.</p>
13091
12916
 
13092
12917
  <div class="doc doc-contents ">
13093
12918
  <p class="doc doc-class-bases">
13094
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.homepage.HomePageBase" href="#nautobot.apps.ui.HomePageBase">HomePageBase</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.base.PermissionsMixin" href="#nautobot.apps.ui.PermissionsMixin">PermissionsMixin</a></code></p>
13095
-
13096
-
13097
- <p>Defines properties that can be used for a panel.</p>
13098
-
13099
-
13100
-
12919
+ Bases: <code><autoref identifier="nautobot.core.ui.homepage.HomePageBase" optional hover>HomePageBase</autoref></code>, <code><autoref identifier="nautobot.core.ui.base.PermissionsMixin" optional hover>PermissionsMixin</autoref></code></p>
13101
12920
 
13102
12921
 
12922
+ <p>Defines properties that can be used for a panel.</p>
13103
12923
 
13104
12924
 
13105
12925
 
@@ -13125,7 +12945,7 @@ Mutually exclusive with <code>column_headers</code>.</p>
13125
12945
 
13126
12946
  <div class="doc doc-contents ">
13127
12947
 
13128
- <p>Ensure panel properties.</p>
12948
+ <p>Ensure panel properties.</p>
13129
12949
 
13130
12950
 
13131
12951
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -13140,11 +12960,9 @@ Mutually exclusive with <code>column_headers</code>.</p>
13140
12960
  </thead>
13141
12961
  <tbody>
13142
12962
  <tr class="doc-section-item">
12963
+ <td><code>name</code></td>
13143
12964
  <td>
13144
- <code>name</code>
13145
- </td>
13146
- <td>
13147
- <code>str</code>
12965
+ <code><autoref identifier="str" optional>str</autoref></code>
13148
12966
  </td>
13149
12967
  <td>
13150
12968
  <div class="doc-md-description">
@@ -13156,11 +12974,9 @@ Mutually exclusive with <code>column_headers</code>.</p>
13156
12974
  </td>
13157
12975
  </tr>
13158
12976
  <tr class="doc-section-item">
12977
+ <td><code>permissions</code></td>
13159
12978
  <td>
13160
- <code>permissions</code>
13161
- </td>
13162
- <td>
13163
- <code>list</code>
12979
+ <code><autoref identifier="list" optional>list</autoref></code>
13164
12980
  </td>
13165
12981
  <td>
13166
12982
  <div class="doc-md-description">
@@ -13172,11 +12988,9 @@ Mutually exclusive with <code>column_headers</code>.</p>
13172
12988
  </td>
13173
12989
  </tr>
13174
12990
  <tr class="doc-section-item">
12991
+ <td><code>custom_data</code></td>
13175
12992
  <td>
13176
- <code>custom_data</code>
13177
- </td>
13178
- <td>
13179
- <code>dict</code>
12993
+ <code><autoref identifier="dict" optional>dict</autoref></code>
13180
12994
  </td>
13181
12995
  <td>
13182
12996
  <div class="doc-md-description">
@@ -13188,11 +13002,9 @@ Mutually exclusive with <code>column_headers</code>.</p>
13188
13002
  </td>
13189
13003
  </tr>
13190
13004
  <tr class="doc-section-item">
13005
+ <td><code>custom_template</code></td>
13191
13006
  <td>
13192
- <code>custom_template</code>
13193
- </td>
13194
- <td>
13195
- <code>str</code>
13007
+ <code><autoref identifier="str" optional>str</autoref></code>
13196
13008
  </td>
13197
13009
  <td>
13198
13010
  <div class="doc-md-description">
@@ -13204,11 +13016,9 @@ Mutually exclusive with <code>column_headers</code>.</p>
13204
13016
  </td>
13205
13017
  </tr>
13206
13018
  <tr class="doc-section-item">
13019
+ <td><code>items</code></td>
13207
13020
  <td>
13208
- <code>items</code>
13209
- </td>
13210
- <td>
13211
- <code>list</code>
13021
+ <code><autoref identifier="list" optional>list</autoref></code>
13212
13022
  </td>
13213
13023
  <td>
13214
13024
  <div class="doc-md-description">
@@ -13220,11 +13030,9 @@ Mutually exclusive with <code>column_headers</code>.</p>
13220
13030
  </td>
13221
13031
  </tr>
13222
13032
  <tr class="doc-section-item">
13033
+ <td><code>weight</code></td>
13223
13034
  <td>
13224
- <code>weight</code>
13225
- </td>
13226
- <td>
13227
- <code>int</code>
13035
+ <code><autoref identifier="int" optional>int</autoref></code>
13228
13036
  </td>
13229
13037
  <td>
13230
13038
  <div class="doc-md-description">
@@ -13263,15 +13071,10 @@ Mutually exclusive with <code>column_headers</code>.</p>
13263
13071
 
13264
13072
  <div class="doc doc-contents ">
13265
13073
  <p class="doc doc-class-bases">
13266
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.Panel" href="#nautobot.apps.ui.Panel">Panel</a></code></p>
13267
-
13268
-
13269
- <p>A panel that displays a two-column table of keys and values, as seen in most object detail views.</p>
13270
-
13271
-
13272
-
13074
+ Bases: <code><autoref identifier="nautobot.core.ui.object_detail.Panel" optional hover>Panel</autoref></code></p>
13273
13075
 
13274
13076
 
13077
+ <p>A panel that displays a two-column table of keys and values, as seen in most object detail views.</p>
13275
13078
 
13276
13079
 
13277
13080
 
@@ -13297,7 +13100,7 @@ Mutually exclusive with <code>column_headers</code>.</p>
13297
13100
 
13298
13101
  <div class="doc doc-contents ">
13299
13102
 
13300
- <p>Instantiate a KeyValueTablePanel.</p>
13103
+ <p>Instantiate a KeyValueTablePanel.</p>
13301
13104
 
13302
13105
 
13303
13106
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -13312,11 +13115,9 @@ Mutually exclusive with <code>column_headers</code>.</p>
13312
13115
  </thead>
13313
13116
  <tbody>
13314
13117
  <tr class="doc-section-item">
13118
+ <td><code>data</code></td>
13315
13119
  <td>
13316
- <code>data</code>
13317
- </td>
13318
- <td>
13319
- <code>dict</code>
13120
+ <code><autoref identifier="dict" optional>dict</autoref></code>
13320
13121
  </td>
13321
13122
  <td>
13322
13123
  <div class="doc-md-description">
@@ -13329,11 +13130,9 @@ May be <code>None</code> if it will be derived dynamically by <code>get_data()</
13329
13130
  </td>
13330
13131
  </tr>
13331
13132
  <tr class="doc-section-item">
13133
+ <td><code>context_data_key</code></td>
13332
13134
  <td>
13333
- <code>context_data_key</code>
13334
- </td>
13335
- <td>
13336
- <code>str</code>
13135
+ <code><autoref identifier="str" optional>str</autoref></code>
13337
13136
  </td>
13338
13137
  <td>
13339
13138
  <div class="doc-md-description">
@@ -13345,11 +13144,9 @@ May be <code>None</code> if it will be derived dynamically by <code>get_data()</
13345
13144
  </td>
13346
13145
  </tr>
13347
13146
  <tr class="doc-section-item">
13147
+ <td><code>hide_if_unset</code></td>
13348
13148
  <td>
13349
- <code>hide_if_unset</code>
13350
- </td>
13351
- <td>
13352
- <code>list</code>
13149
+ <code><autoref identifier="list" optional>list</autoref></code>
13353
13150
  </td>
13354
13151
  <td>
13355
13152
  <div class="doc-md-description">
@@ -13362,11 +13159,9 @@ instead of displaying the usual em-dash placeholder text.</p>
13362
13159
  </td>
13363
13160
  </tr>
13364
13161
  <tr class="doc-section-item">
13162
+ <td><code>value_transforms</code></td>
13365
13163
  <td>
13366
- <code>value_transforms</code>
13367
- </td>
13368
- <td>
13369
- <code>dict</code>
13164
+ <code><autoref identifier="dict" optional>dict</autoref></code>
13370
13165
  </td>
13371
13166
  <td>
13372
13167
  <div class="doc-md-description">
@@ -13401,7 +13196,7 @@ Many of the <code>templatetags.helpers</code> functions are suitable for this pu
13401
13196
 
13402
13197
  <div class="doc doc-contents ">
13403
13198
 
13404
- <p>Get the data for this panel, by default from <code>self.data</code> or the key <code>"data"</code> in the provided context.</p>
13199
+ <p>Get the data for this panel, by default from <code>self.data</code> or the key <code>"data"</code> in the provided context.</p>
13405
13200
  <p>Subclasses may need to override this method if the derivation of the data is more involved.</p>
13406
13201
 
13407
13202
 
@@ -13416,7 +13211,7 @@ Many of the <code>templatetags.helpers</code> functions are suitable for this pu
13416
13211
  <tbody>
13417
13212
  <tr class="doc-section-item">
13418
13213
  <td>
13419
- <code>dict</code>
13214
+ <code><autoref identifier="dict" optional>dict</autoref></code>
13420
13215
  </td>
13421
13216
  <td>
13422
13217
  <div class="doc-md-description">
@@ -13442,7 +13237,7 @@ Many of the <code>templatetags.helpers</code> functions are suitable for this pu
13442
13237
 
13443
13238
  <div class="doc doc-contents ">
13444
13239
 
13445
- <p>Get a filter parameter to use when hyperlinking queryset data to an object list URL to provide filtering.</p>
13240
+ <p>Get a filter parameter to use when hyperlinking queryset data to an object list URL to provide filtering.</p>
13446
13241
 
13447
13242
 
13448
13243
  <p><span class="doc-section-title">Returns:</span></p>
@@ -13456,7 +13251,7 @@ Many of the <code>templatetags.helpers</code> functions are suitable for this pu
13456
13251
  <tbody>
13457
13252
  <tr class="doc-section-item">
13458
13253
  <td>
13459
- <code>str</code>
13254
+ <code><autoref identifier="str" optional>str</autoref></code>
13460
13255
  </td>
13461
13256
  <td>
13462
13257
  <div class="doc-md-description">
@@ -13466,7 +13261,7 @@ Many of the <code>templatetags.helpers</code> functions are suitable for this pu
13466
13261
  </tr>
13467
13262
  </tbody>
13468
13263
  </table>
13469
- <p>The default implementation returns <code>""</code>, which means "no appropriate filter parameter is known,
13264
+ <p>The default implementation returns <code>""</code>, which means "no appropriate filter parameter is known,
13470
13265
  do not hyperlink the queryset text." Subclasses may wish to override this to provide appropriate intelligence.</p>
13471
13266
 
13472
13267
 
@@ -13496,7 +13291,7 @@ do not hyperlink the queryset text." Subclasses may wish to override this to pro
13496
13291
 
13497
13292
  <div class="doc doc-contents ">
13498
13293
 
13499
- <p>Render key-value pairs as table rows, using <code>render_key()</code> and <code>render_value()</code> methods as applicable.</p>
13294
+ <p>Render key-value pairs as table rows, using <code>render_key()</code> and <code>render_value()</code> methods as applicable.</p>
13500
13295
 
13501
13296
  </div>
13502
13297
 
@@ -13513,7 +13308,7 @@ do not hyperlink the queryset text." Subclasses may wish to override this to pro
13513
13308
 
13514
13309
  <div class="doc doc-contents ">
13515
13310
 
13516
- <p>Render the provided key in human-readable form.</p>
13311
+ <p>Render the provided key in human-readable form.</p>
13517
13312
  <p>The default implementation simply replaces underscores with spaces and title-cases it with <code>bettertitle()</code>.</p>
13518
13313
 
13519
13314
  </div>
@@ -13531,7 +13326,7 @@ do not hyperlink the queryset text." Subclasses may wish to override this to pro
13531
13326
 
13532
13327
  <div class="doc doc-contents ">
13533
13328
 
13534
- <p>Render the provided value in human-readable form.</p>
13329
+ <p>Render the provided value in human-readable form.</p>
13535
13330
 
13536
13331
 
13537
13332
  <p><span class="doc-section-title">Returns:</span></p>
@@ -13545,7 +13340,7 @@ do not hyperlink the queryset text." Subclasses may wish to override this to pro
13545
13340
  <tbody>
13546
13341
  <tr class="doc-section-item">
13547
13342
  <td>
13548
- <code>str</code>
13343
+ <code><autoref identifier="str" optional>str</autoref></code>
13549
13344
  </td>
13550
13345
  <td>
13551
13346
  <div class="doc-md-description">
@@ -13557,7 +13352,7 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
13557
13352
  </tr>
13558
13353
  </tbody>
13559
13354
  </table>
13560
- <p>Behavior is influenced by:</p>
13355
+ <p>Behavior is influenced by:</p>
13561
13356
  <ul>
13562
13357
  <li><code>self.value_transforms</code> - if it has an entry for the given <code>key</code>, then the given functions provided there
13563
13358
  will be used to render the <code>value</code>, in place of any default processing and rendering for this data type.</li>
@@ -13601,10 +13396,10 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
13601
13396
 
13602
13397
  <div class="doc doc-contents ">
13603
13398
  <p class="doc doc-class-bases">
13604
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.choices.ChoiceSet" href="choices.html#nautobot.apps.choices.ChoiceSet">ChoiceSet</a></code></p>
13399
+ Bases: <code><autoref identifier="nautobot.core.choices.ChoiceSet" optional hover>ChoiceSet</autoref></code></p>
13605
13400
 
13606
13401
 
13607
- <p>Page (or more properly tab) column layout choices.</p>
13402
+ <p>Page (or more properly tab) column layout choices.</p>
13608
13403
 
13609
13404
 
13610
13405
  <p><span class="doc-section-title">Attributes:</span></p>
@@ -13618,9 +13413,9 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
13618
13413
  </thead>
13619
13414
  <tbody>
13620
13415
  <tr class="doc-section-item">
13621
- <td><code><span title="nautobot.apps.ui.LayoutChoices.TWO_OVER_ONE">TWO_OVER_ONE</span></code></td>
13416
+ <td><code><autoref identifier="nautobot.apps.ui.LayoutChoices.TWO_OVER_ONE" optional hover>TWO_OVER_ONE</autoref></code></td>
13622
13417
  <td>
13623
- <code>str</code>
13418
+ <code><autoref identifier="str" optional>str</autoref></code>
13624
13419
  </td>
13625
13420
  <td>
13626
13421
  <div class="doc-md-description">
@@ -13629,9 +13424,9 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
13629
13424
  </td>
13630
13425
  </tr>
13631
13426
  <tr class="doc-section-item">
13632
- <td><code><span title="nautobot.apps.ui.LayoutChoices.ONE_OVER_TWO">ONE_OVER_TWO</span></code></td>
13427
+ <td><code><autoref identifier="nautobot.apps.ui.LayoutChoices.ONE_OVER_TWO" optional hover>ONE_OVER_TWO</autoref></code></td>
13633
13428
  <td>
13634
- <code>str</code>
13429
+ <code><autoref identifier="str" optional>str</autoref></code>
13635
13430
  </td>
13636
13431
  <td>
13637
13432
  <div class="doc-md-description">
@@ -13640,9 +13435,9 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
13640
13435
  </td>
13641
13436
  </tr>
13642
13437
  <tr class="doc-section-item">
13643
- <td><code><span title="nautobot.apps.ui.LayoutChoices.DEFAULT">DEFAULT</span></code></td>
13438
+ <td><code><autoref identifier="nautobot.apps.ui.LayoutChoices.DEFAULT" optional hover>DEFAULT</autoref></code></td>
13644
13439
  <td>
13645
- <code>str</code>
13440
+ <code><autoref identifier="str" optional>str</autoref></code>
13646
13441
  </td>
13647
13442
  <td>
13648
13443
  <div class="doc-md-description">
@@ -13656,11 +13451,6 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
13656
13451
 
13657
13452
 
13658
13453
 
13659
-
13660
-
13661
-
13662
-
13663
-
13664
13454
  <div class="doc doc-children">
13665
13455
 
13666
13456
 
@@ -13692,15 +13482,10 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
13692
13482
 
13693
13483
  <div class="doc doc-contents ">
13694
13484
  <p class="doc doc-class-bases">
13695
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.nav.NavMenuButton" href="#nautobot.apps.ui.NavMenuButton">NavMenuButton</a></code></p>
13696
-
13697
-
13698
- <p>Add button subclass.</p>
13699
-
13700
-
13701
-
13485
+ Bases: <code><autoref identifier="nautobot.core.ui.nav.NavMenuButton" optional hover>NavMenuButton</autoref></code></p>
13702
13486
 
13703
13487
 
13488
+ <p>Add button subclass.</p>
13704
13489
 
13705
13490
 
13706
13491
 
@@ -13726,7 +13511,7 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
13726
13511
 
13727
13512
  <div class="doc doc-contents ">
13728
13513
 
13729
- <p>Ensure button properties.</p>
13514
+ <p>Ensure button properties.</p>
13730
13515
 
13731
13516
  </div>
13732
13517
 
@@ -13753,15 +13538,10 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
13753
13538
 
13754
13539
  <div class="doc doc-contents ">
13755
13540
  <p class="doc doc-class-bases">
13756
- Bases: <code><span title="abc.ABC">ABC</span></code></p>
13757
-
13758
-
13759
- <p>Base class for navigation classes.</p>
13760
-
13761
-
13762
-
13541
+ Bases: <code><autoref identifier="abc.ABC" optional hover>ABC</autoref></code></p>
13763
13542
 
13764
13543
 
13544
+ <p>Base class for navigation classes.</p>
13765
13545
 
13766
13546
 
13767
13547
 
@@ -13779,7 +13559,7 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
13779
13559
 
13780
13560
 
13781
13561
  <h3 id="nautobot.apps.ui.NavMenuBase.fixed_fields" class="doc doc-heading">
13782
- <code class="highlight language-python"><span class="n">fixed_fields</span></code>
13562
+ <code class="highlight language-python"><span class="n">fixed_fields</span><span class="p">:</span> <span class="nb">tuple</span></code>
13783
13563
 
13784
13564
  <span class="doc doc-labels">
13785
13565
  <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small>
@@ -13791,7 +13571,7 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
13791
13571
 
13792
13572
  <div class="doc doc-contents ">
13793
13573
 
13794
- <p>Tuple of (name, attribute) entries describing fields that may not be altered after declaration.</p>
13574
+ <p>Tuple of (name, attribute) entries describing fields that may not be altered after declaration.</p>
13795
13575
  </div>
13796
13576
 
13797
13577
  </div>
@@ -13801,7 +13581,7 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
13801
13581
 
13802
13582
 
13803
13583
  <h3 id="nautobot.apps.ui.NavMenuBase.initial_dict" class="doc doc-heading">
13804
- <code class="highlight language-python"><span class="n">initial_dict</span></code>
13584
+ <code class="highlight language-python"><span class="n">initial_dict</span><span class="p">:</span> <span class="nb">dict</span></code>
13805
13585
 
13806
13586
  <span class="doc doc-labels">
13807
13587
  <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small>
@@ -13813,7 +13593,7 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
13813
13593
 
13814
13594
  <div class="doc doc-contents ">
13815
13595
 
13816
- <p>Attributes to be stored when adding this item to the nav menu data for the first time.</p>
13596
+ <p>Attributes to be stored when adding this item to the nav menu data for the first time.</p>
13817
13597
  </div>
13818
13598
 
13819
13599
  </div>
@@ -13841,15 +13621,10 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
13841
13621
 
13842
13622
  <div class="doc doc-contents ">
13843
13623
  <p class="doc doc-class-bases">
13844
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.nav.NavMenuBase" href="#nautobot.apps.ui.NavMenuBase">NavMenuBase</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.base.PermissionsMixin" href="#nautobot.apps.ui.PermissionsMixin">PermissionsMixin</a></code></p>
13845
-
13846
-
13847
- <p>This class represents a button within a NavMenuItem.</p>
13848
-
13849
-
13850
-
13624
+ Bases: <code><autoref identifier="nautobot.core.ui.nav.NavMenuBase" optional hover>NavMenuBase</autoref></code>, <code><autoref identifier="nautobot.core.ui.base.PermissionsMixin" optional hover>PermissionsMixin</autoref></code></p>
13851
13625
 
13852
13626
 
13627
+ <p>This class represents a button within a NavMenuItem.</p>
13853
13628
 
13854
13629
 
13855
13630
 
@@ -13867,7 +13642,7 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
13867
13642
 
13868
13643
 
13869
13644
  <h3 id="nautobot.apps.ui.NavMenuButton.fixed_fields" class="doc doc-heading">
13870
- <code class="highlight language-python"><span class="n">fixed_fields</span></code>
13645
+ <code class="highlight language-python"><span class="n">fixed_fields</span><span class="p">:</span> <span class="nb">tuple</span></code>
13871
13646
 
13872
13647
  <span class="doc doc-labels">
13873
13648
  <small class="doc doc-label doc-label-property"><code>property</code></small>
@@ -13878,7 +13653,7 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
13878
13653
 
13879
13654
  <div class="doc doc-contents ">
13880
13655
 
13881
- <p>Tuple of (name, attribute) entries describing fields that may not be altered after declaration.</p>
13656
+ <p>Tuple of (name, attribute) entries describing fields that may not be altered after declaration.</p>
13882
13657
  </div>
13883
13658
 
13884
13659
  </div>
@@ -13888,7 +13663,7 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
13888
13663
 
13889
13664
 
13890
13665
  <h3 id="nautobot.apps.ui.NavMenuButton.initial_dict" class="doc doc-heading">
13891
- <code class="highlight language-python"><span class="n">initial_dict</span></code>
13666
+ <code class="highlight language-python"><span class="n">initial_dict</span><span class="p">:</span> <span class="nb">dict</span></code>
13892
13667
 
13893
13668
  <span class="doc doc-labels">
13894
13669
  <small class="doc doc-label doc-label-property"><code>property</code></small>
@@ -13899,7 +13674,7 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
13899
13674
 
13900
13675
  <div class="doc doc-contents ">
13901
13676
 
13902
- <p>Attributes to be stored when adding this item to the nav menu data for the first time.</p>
13677
+ <p>Attributes to be stored when adding this item to the nav menu data for the first time.</p>
13903
13678
  </div>
13904
13679
 
13905
13680
  </div>
@@ -13917,7 +13692,7 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
13917
13692
 
13918
13693
  <div class="doc doc-contents ">
13919
13694
 
13920
- <p>Ensure button properties.</p>
13695
+ <p>Ensure button properties.</p>
13921
13696
 
13922
13697
 
13923
13698
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -13932,11 +13707,9 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
13932
13707
  </thead>
13933
13708
  <tbody>
13934
13709
  <tr class="doc-section-item">
13710
+ <td><code>link</code></td>
13935
13711
  <td>
13936
- <code>link</code>
13937
- </td>
13938
- <td>
13939
- <code>str</code>
13712
+ <code><autoref identifier="str" optional>str</autoref></code>
13940
13713
  </td>
13941
13714
  <td>
13942
13715
  <div class="doc-md-description">
@@ -13948,11 +13721,9 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
13948
13721
  </td>
13949
13722
  </tr>
13950
13723
  <tr class="doc-section-item">
13724
+ <td><code>title</code></td>
13951
13725
  <td>
13952
- <code>title</code>
13953
- </td>
13954
- <td>
13955
- <code>str</code>
13726
+ <code><autoref identifier="str" optional>str</autoref></code>
13956
13727
  </td>
13957
13728
  <td>
13958
13729
  <div class="doc-md-description">
@@ -13964,11 +13735,9 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
13964
13735
  </td>
13965
13736
  </tr>
13966
13737
  <tr class="doc-section-item">
13738
+ <td><code>icon_class</code></td>
13967
13739
  <td>
13968
- <code>icon_class</code>
13969
- </td>
13970
- <td>
13971
- <code>str</code>
13740
+ <code><autoref identifier="str" optional>str</autoref></code>
13972
13741
  </td>
13973
13742
  <td>
13974
13743
  <div class="doc-md-description">
@@ -13980,11 +13749,9 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
13980
13749
  </td>
13981
13750
  </tr>
13982
13751
  <tr class="doc-section-item">
13752
+ <td><code>button_class</code></td>
13983
13753
  <td>
13984
- <code>button_class</code>
13985
- </td>
13986
- <td>
13987
- <code>str</code>
13754
+ <code><autoref identifier="str" optional>str</autoref></code>
13988
13755
  </td>
13989
13756
  <td>
13990
13757
  <div class="doc-md-description">
@@ -13992,15 +13759,13 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
13992
13759
  </div>
13993
13760
  </td>
13994
13761
  <td>
13995
- <code><span title="nautobot.core.choices.ButtonActionColorChoices.DEFAULT">DEFAULT</span></code>
13762
+ <code><autoref identifier="nautobot.core.choices.ButtonActionColorChoices.DEFAULT" optional hover>DEFAULT</autoref></code>
13996
13763
  </td>
13997
13764
  </tr>
13998
13765
  <tr class="doc-section-item">
13766
+ <td><code>permissions</code></td>
13999
13767
  <td>
14000
- <code>permissions</code>
14001
- </td>
14002
- <td>
14003
- <code>list</code>
13768
+ <code><autoref identifier="list" optional>list</autoref></code>
14004
13769
  </td>
14005
13770
  <td>
14006
13771
  <div class="doc-md-description">
@@ -14012,11 +13777,9 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
14012
13777
  </td>
14013
13778
  </tr>
14014
13779
  <tr class="doc-section-item">
13780
+ <td><code>weight</code></td>
14015
13781
  <td>
14016
- <code>weight</code>
14017
- </td>
14018
- <td>
14019
- <code>int</code>
13782
+ <code><autoref identifier="int" optional>int</autoref></code>
14020
13783
  </td>
14021
13784
  <td>
14022
13785
  <div class="doc-md-description">
@@ -14028,11 +13791,9 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
14028
13791
  </td>
14029
13792
  </tr>
14030
13793
  <tr class="doc-section-item">
13794
+ <td><code>query_params</code></td>
14031
13795
  <td>
14032
- <code>query_params</code>
14033
- </td>
14034
- <td>
14035
- <code>dict</code>
13796
+ <code><autoref identifier="dict" optional>dict</autoref></code>
14036
13797
  </td>
14037
13798
  <td>
14038
13799
  <div class="doc-md-description">
@@ -14071,21 +13832,16 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
14071
13832
 
14072
13833
  <div class="doc doc-contents ">
14073
13834
  <p class="doc doc-class-bases">
14074
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.nav.NavMenuBase" href="#nautobot.apps.ui.NavMenuBase">NavMenuBase</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.base.PermissionsMixin" href="#nautobot.apps.ui.PermissionsMixin">PermissionsMixin</a></code></p>
13835
+ Bases: <code><autoref identifier="nautobot.core.ui.nav.NavMenuBase" optional hover>NavMenuBase</autoref></code>, <code><autoref identifier="nautobot.core.ui.base.PermissionsMixin" optional hover>PermissionsMixin</autoref></code></p>
14075
13836
 
14076
13837
 
14077
- <p>Ths class represents a navigation menu group. This is built up from a name and a weight value. The name is
13838
+ <p>Ths class represents a navigation menu group. This is built up from a name and a weight value. The name is
14078
13839
  the display text and the weight defines its position in the navbar.</p>
14079
13840
  <p>Items are each specified as a list of NavMenuItem instances.</p>
14080
13841
 
14081
13842
 
14082
13843
 
14083
13844
 
14084
-
14085
-
14086
-
14087
-
14088
-
14089
13845
  <div class="doc doc-children">
14090
13846
 
14091
13847
 
@@ -14099,7 +13855,7 @@ the display text and the weight defines its position in the navbar.</p>
14099
13855
 
14100
13856
 
14101
13857
  <h3 id="nautobot.apps.ui.NavMenuGroup.fixed_fields" class="doc doc-heading">
14102
- <code class="highlight language-python"><span class="n">fixed_fields</span></code>
13858
+ <code class="highlight language-python"><span class="n">fixed_fields</span><span class="p">:</span> <span class="nb">tuple</span></code>
14103
13859
 
14104
13860
  <span class="doc doc-labels">
14105
13861
  <small class="doc doc-label doc-label-property"><code>property</code></small>
@@ -14110,7 +13866,7 @@ the display text and the weight defines its position in the navbar.</p>
14110
13866
 
14111
13867
  <div class="doc doc-contents ">
14112
13868
 
14113
- <p>Tuple of (name, attribute) entries describing fields that may not be altered after declaration.</p>
13869
+ <p>Tuple of (name, attribute) entries describing fields that may not be altered after declaration.</p>
14114
13870
  </div>
14115
13871
 
14116
13872
  </div>
@@ -14120,7 +13876,7 @@ the display text and the weight defines its position in the navbar.</p>
14120
13876
 
14121
13877
 
14122
13878
  <h3 id="nautobot.apps.ui.NavMenuGroup.initial_dict" class="doc doc-heading">
14123
- <code class="highlight language-python"><span class="n">initial_dict</span></code>
13879
+ <code class="highlight language-python"><span class="n">initial_dict</span><span class="p">:</span> <span class="nb">dict</span></code>
14124
13880
 
14125
13881
  <span class="doc doc-labels">
14126
13882
  <small class="doc doc-label doc-label-property"><code>property</code></small>
@@ -14131,7 +13887,7 @@ the display text and the weight defines its position in the navbar.</p>
14131
13887
 
14132
13888
  <div class="doc doc-contents ">
14133
13889
 
14134
- <p>Attributes to be stored when adding this item to the nav menu data for the first time.</p>
13890
+ <p>Attributes to be stored when adding this item to the nav menu data for the first time.</p>
14135
13891
  </div>
14136
13892
 
14137
13893
  </div>
@@ -14149,7 +13905,7 @@ the display text and the weight defines its position in the navbar.</p>
14149
13905
 
14150
13906
  <div class="doc doc-contents ">
14151
13907
 
14152
- <p>Ensure group properties.</p>
13908
+ <p>Ensure group properties.</p>
14153
13909
 
14154
13910
 
14155
13911
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -14164,11 +13920,9 @@ the display text and the weight defines its position in the navbar.</p>
14164
13920
  </thead>
14165
13921
  <tbody>
14166
13922
  <tr class="doc-section-item">
13923
+ <td><code>name</code></td>
14167
13924
  <td>
14168
- <code>name</code>
14169
- </td>
14170
- <td>
14171
- <code>str</code>
13925
+ <code><autoref identifier="str" optional>str</autoref></code>
14172
13926
  </td>
14173
13927
  <td>
14174
13928
  <div class="doc-md-description">
@@ -14180,11 +13934,9 @@ the display text and the weight defines its position in the navbar.</p>
14180
13934
  </td>
14181
13935
  </tr>
14182
13936
  <tr class="doc-section-item">
13937
+ <td><code>items</code></td>
14183
13938
  <td>
14184
- <code>items</code>
14185
- </td>
14186
- <td>
14187
- <code>list</code>
13939
+ <code><autoref identifier="list" optional>list</autoref></code>
14188
13940
  </td>
14189
13941
  <td>
14190
13942
  <div class="doc-md-description">
@@ -14196,11 +13948,9 @@ the display text and the weight defines its position in the navbar.</p>
14196
13948
  </td>
14197
13949
  </tr>
14198
13950
  <tr class="doc-section-item">
13951
+ <td><code>weight</code></td>
14199
13952
  <td>
14200
- <code>weight</code>
14201
- </td>
14202
- <td>
14203
- <code>int</code>
13953
+ <code><autoref identifier="int" optional>int</autoref></code>
14204
13954
  </td>
14205
13955
  <td>
14206
13956
  <div class="doc-md-description">
@@ -14239,15 +13989,10 @@ the display text and the weight defines its position in the navbar.</p>
14239
13989
 
14240
13990
  <div class="doc doc-contents ">
14241
13991
  <p class="doc doc-class-bases">
14242
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.nav.NavMenuButton" href="#nautobot.apps.ui.NavMenuButton">NavMenuButton</a></code></p>
14243
-
14244
-
14245
- <p>Import button subclass.</p>
14246
-
14247
-
14248
-
13992
+ Bases: <code><autoref identifier="nautobot.core.ui.nav.NavMenuButton" optional hover>NavMenuButton</autoref></code></p>
14249
13993
 
14250
13994
 
13995
+ <p>Import button subclass.</p>
14251
13996
 
14252
13997
 
14253
13998
 
@@ -14273,7 +14018,7 @@ the display text and the weight defines its position in the navbar.</p>
14273
14018
 
14274
14019
  <div class="doc doc-contents ">
14275
14020
 
14276
- <p>Ensure button properties.</p>
14021
+ <p>Ensure button properties.</p>
14277
14022
 
14278
14023
  </div>
14279
14024
 
@@ -14300,10 +14045,10 @@ the display text and the weight defines its position in the navbar.</p>
14300
14045
 
14301
14046
  <div class="doc doc-contents ">
14302
14047
  <p class="doc doc-class-bases">
14303
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.nav.NavMenuBase" href="#nautobot.apps.ui.NavMenuBase">NavMenuBase</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.base.PermissionsMixin" href="#nautobot.apps.ui.PermissionsMixin">PermissionsMixin</a></code></p>
14048
+ Bases: <code><autoref identifier="nautobot.core.ui.nav.NavMenuBase" optional hover>NavMenuBase</autoref></code>, <code><autoref identifier="nautobot.core.ui.base.PermissionsMixin" optional hover>PermissionsMixin</autoref></code></p>
14304
14049
 
14305
14050
 
14306
- <p>This class represents a navigation menu item. This constitutes primary link and its text, but also allows for
14051
+ <p>This class represents a navigation menu item. This constitutes primary link and its text, but also allows for
14307
14052
  specifying additional link buttons that appear to the right of the item in the nav menu.</p>
14308
14053
  <p>Links are specified as Django reverse URL strings.
14309
14054
  Buttons are each specified as a list of NavMenuButton instances.</p>
@@ -14311,11 +14056,6 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
14311
14056
 
14312
14057
 
14313
14058
 
14314
-
14315
-
14316
-
14317
-
14318
-
14319
14059
  <div class="doc doc-children">
14320
14060
 
14321
14061
 
@@ -14329,7 +14069,7 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
14329
14069
 
14330
14070
 
14331
14071
  <h3 id="nautobot.apps.ui.NavMenuItem.fixed_fields" class="doc doc-heading">
14332
- <code class="highlight language-python"><span class="n">fixed_fields</span></code>
14072
+ <code class="highlight language-python"><span class="n">fixed_fields</span><span class="p">:</span> <span class="nb">tuple</span></code>
14333
14073
 
14334
14074
  <span class="doc doc-labels">
14335
14075
  <small class="doc doc-label doc-label-property"><code>property</code></small>
@@ -14340,7 +14080,7 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
14340
14080
 
14341
14081
  <div class="doc doc-contents ">
14342
14082
 
14343
- <p>Tuple of (name, attribute) entries describing fields that may not be altered after declaration.</p>
14083
+ <p>Tuple of (name, attribute) entries describing fields that may not be altered after declaration.</p>
14344
14084
  </div>
14345
14085
 
14346
14086
  </div>
@@ -14350,7 +14090,7 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
14350
14090
 
14351
14091
 
14352
14092
  <h3 id="nautobot.apps.ui.NavMenuItem.initial_dict" class="doc doc-heading">
14353
- <code class="highlight language-python"><span class="n">initial_dict</span></code>
14093
+ <code class="highlight language-python"><span class="n">initial_dict</span><span class="p">:</span> <span class="nb">dict</span></code>
14354
14094
 
14355
14095
  <span class="doc doc-labels">
14356
14096
  <small class="doc doc-label doc-label-property"><code>property</code></small>
@@ -14361,7 +14101,7 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
14361
14101
 
14362
14102
  <div class="doc doc-contents ">
14363
14103
 
14364
- <p>Attributes to be stored when adding this item to the nav menu data for the first time.</p>
14104
+ <p>Attributes to be stored when adding this item to the nav menu data for the first time.</p>
14365
14105
  </div>
14366
14106
 
14367
14107
  </div>
@@ -14379,7 +14119,7 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
14379
14119
 
14380
14120
  <div class="doc doc-contents ">
14381
14121
 
14382
- <p>Ensure item properties.</p>
14122
+ <p>Ensure item properties.</p>
14383
14123
 
14384
14124
 
14385
14125
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -14394,11 +14134,9 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
14394
14134
  </thead>
14395
14135
  <tbody>
14396
14136
  <tr class="doc-section-item">
14137
+ <td><code>link</code></td>
14397
14138
  <td>
14398
- <code>link</code>
14399
- </td>
14400
- <td>
14401
- <code>str</code>
14139
+ <code><autoref identifier="str" optional>str</autoref></code>
14402
14140
  </td>
14403
14141
  <td>
14404
14142
  <div class="doc-md-description">
@@ -14410,11 +14148,9 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
14410
14148
  </td>
14411
14149
  </tr>
14412
14150
  <tr class="doc-section-item">
14151
+ <td><code>name</code></td>
14413
14152
  <td>
14414
- <code>name</code>
14415
- </td>
14416
- <td>
14417
- <code>str</code>
14153
+ <code><autoref identifier="str" optional>str</autoref></code>
14418
14154
  </td>
14419
14155
  <td>
14420
14156
  <div class="doc-md-description">
@@ -14426,11 +14162,9 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
14426
14162
  </td>
14427
14163
  </tr>
14428
14164
  <tr class="doc-section-item">
14165
+ <td><code>args</code></td>
14429
14166
  <td>
14430
- <code>args</code>
14431
- </td>
14432
- <td>
14433
- <code>list</code>
14167
+ <code><autoref identifier="list" optional>list</autoref></code>
14434
14168
  </td>
14435
14169
  <td>
14436
14170
  <div class="doc-md-description">
@@ -14442,11 +14176,9 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
14442
14176
  </td>
14443
14177
  </tr>
14444
14178
  <tr class="doc-section-item">
14179
+ <td><code>kwargs</code></td>
14445
14180
  <td>
14446
- <code>kwargs</code>
14447
- </td>
14448
- <td>
14449
- <code>dict</code>
14181
+ <code><autoref identifier="dict" optional>dict</autoref></code>
14450
14182
  </td>
14451
14183
  <td>
14452
14184
  <div class="doc-md-description">
@@ -14458,11 +14190,9 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
14458
14190
  </td>
14459
14191
  </tr>
14460
14192
  <tr class="doc-section-item">
14193
+ <td><code>query_params</code></td>
14461
14194
  <td>
14462
- <code>query_params</code>
14463
- </td>
14464
- <td>
14465
- <code>dict</code>
14195
+ <code><autoref identifier="dict" optional>dict</autoref></code>
14466
14196
  </td>
14467
14197
  <td>
14468
14198
  <div class="doc-md-description">
@@ -14474,11 +14204,9 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
14474
14204
  </td>
14475
14205
  </tr>
14476
14206
  <tr class="doc-section-item">
14207
+ <td><code>permissions</code></td>
14477
14208
  <td>
14478
- <code>permissions</code>
14479
- </td>
14480
- <td>
14481
- <code>list</code>
14209
+ <code><autoref identifier="list" optional>list</autoref></code>
14482
14210
  </td>
14483
14211
  <td>
14484
14212
  <div class="doc-md-description">
@@ -14490,11 +14218,9 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
14490
14218
  </td>
14491
14219
  </tr>
14492
14220
  <tr class="doc-section-item">
14221
+ <td><code>buttons</code></td>
14493
14222
  <td>
14494
- <code>buttons</code>
14495
- </td>
14496
- <td>
14497
- <code>list</code>
14223
+ <code><autoref identifier="list" optional>list</autoref></code>
14498
14224
  </td>
14499
14225
  <td>
14500
14226
  <div class="doc-md-description">
@@ -14506,11 +14232,9 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
14506
14232
  </td>
14507
14233
  </tr>
14508
14234
  <tr class="doc-section-item">
14235
+ <td><code>weight</code></td>
14509
14236
  <td>
14510
- <code>weight</code>
14511
- </td>
14512
- <td>
14513
- <code>int</code>
14237
+ <code><autoref identifier="int" optional>int</autoref></code>
14514
14238
  </td>
14515
14239
  <td>
14516
14240
  <div class="doc-md-description">
@@ -14549,21 +14273,16 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
14549
14273
 
14550
14274
  <div class="doc doc-contents ">
14551
14275
  <p class="doc doc-class-bases">
14552
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.nav.NavMenuBase" href="#nautobot.apps.ui.NavMenuBase">NavMenuBase</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.base.PermissionsMixin" href="#nautobot.apps.ui.PermissionsMixin">PermissionsMixin</a></code></p>
14276
+ Bases: <code><autoref identifier="nautobot.core.ui.nav.NavMenuBase" optional hover>NavMenuBase</autoref></code>, <code><autoref identifier="nautobot.core.ui.base.PermissionsMixin" optional hover>PermissionsMixin</autoref></code></p>
14553
14277
 
14554
14278
 
14555
- <p>Ths class represents a navigation menu tab. This is built up from a name and a weight value. The name is
14279
+ <p>Ths class represents a navigation menu tab. This is built up from a name and a weight value. The name is
14556
14280
  the display text and the weight defines its position in the navbar.</p>
14557
14281
  <p>Groups are each specified as a list of NavMenuGroup instances.</p>
14558
14282
 
14559
14283
 
14560
14284
 
14561
14285
 
14562
-
14563
-
14564
-
14565
-
14566
-
14567
14286
  <div class="doc doc-children">
14568
14287
 
14569
14288
 
@@ -14577,7 +14296,7 @@ the display text and the weight defines its position in the navbar.</p>
14577
14296
 
14578
14297
 
14579
14298
  <h3 id="nautobot.apps.ui.NavMenuTab.fixed_fields" class="doc doc-heading">
14580
- <code class="highlight language-python"><span class="n">fixed_fields</span></code>
14299
+ <code class="highlight language-python"><span class="n">fixed_fields</span><span class="p">:</span> <span class="nb">tuple</span></code>
14581
14300
 
14582
14301
  <span class="doc doc-labels">
14583
14302
  <small class="doc doc-label doc-label-property"><code>property</code></small>
@@ -14588,7 +14307,7 @@ the display text and the weight defines its position in the navbar.</p>
14588
14307
 
14589
14308
  <div class="doc doc-contents ">
14590
14309
 
14591
- <p>Tuple of (name, attribute) entries describing fields that may not be altered after declaration.</p>
14310
+ <p>Tuple of (name, attribute) entries describing fields that may not be altered after declaration.</p>
14592
14311
  </div>
14593
14312
 
14594
14313
  </div>
@@ -14598,7 +14317,7 @@ the display text and the weight defines its position in the navbar.</p>
14598
14317
 
14599
14318
 
14600
14319
  <h3 id="nautobot.apps.ui.NavMenuTab.initial_dict" class="doc doc-heading">
14601
- <code class="highlight language-python"><span class="n">initial_dict</span></code>
14320
+ <code class="highlight language-python"><span class="n">initial_dict</span><span class="p">:</span> <span class="nb">dict</span></code>
14602
14321
 
14603
14322
  <span class="doc doc-labels">
14604
14323
  <small class="doc doc-label doc-label-property"><code>property</code></small>
@@ -14609,7 +14328,7 @@ the display text and the weight defines its position in the navbar.</p>
14609
14328
 
14610
14329
  <div class="doc doc-contents ">
14611
14330
 
14612
- <p>Attributes to be stored when adding this item to the nav menu data for the first time.</p>
14331
+ <p>Attributes to be stored when adding this item to the nav menu data for the first time.</p>
14613
14332
  </div>
14614
14333
 
14615
14334
  </div>
@@ -14627,7 +14346,7 @@ the display text and the weight defines its position in the navbar.</p>
14627
14346
 
14628
14347
  <div class="doc doc-contents ">
14629
14348
 
14630
- <p>Ensure tab properties.</p>
14349
+ <p>Ensure tab properties.</p>
14631
14350
 
14632
14351
 
14633
14352
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -14642,11 +14361,9 @@ the display text and the weight defines its position in the navbar.</p>
14642
14361
  </thead>
14643
14362
  <tbody>
14644
14363
  <tr class="doc-section-item">
14364
+ <td><code>name</code></td>
14645
14365
  <td>
14646
- <code>name</code>
14647
- </td>
14648
- <td>
14649
- <code>str</code>
14366
+ <code><autoref identifier="str" optional>str</autoref></code>
14650
14367
  </td>
14651
14368
  <td>
14652
14369
  <div class="doc-md-description">
@@ -14658,11 +14375,9 @@ the display text and the weight defines its position in the navbar.</p>
14658
14375
  </td>
14659
14376
  </tr>
14660
14377
  <tr class="doc-section-item">
14378
+ <td><code>permissions</code></td>
14661
14379
  <td>
14662
- <code>permissions</code>
14663
- </td>
14664
- <td>
14665
- <code>list</code>
14380
+ <code><autoref identifier="list" optional>list</autoref></code>
14666
14381
  </td>
14667
14382
  <td>
14668
14383
  <div class="doc-md-description">
@@ -14674,11 +14389,9 @@ the display text and the weight defines its position in the navbar.</p>
14674
14389
  </td>
14675
14390
  </tr>
14676
14391
  <tr class="doc-section-item">
14392
+ <td><code>groups</code></td>
14677
14393
  <td>
14678
- <code>groups</code>
14679
- </td>
14680
- <td>
14681
- <code>list</code>
14394
+ <code><autoref identifier="list" optional>list</autoref></code>
14682
14395
  </td>
14683
14396
  <td>
14684
14397
  <div class="doc-md-description">
@@ -14690,11 +14403,9 @@ the display text and the weight defines its position in the navbar.</p>
14690
14403
  </td>
14691
14404
  </tr>
14692
14405
  <tr class="doc-section-item">
14406
+ <td><code>weight</code></td>
14693
14407
  <td>
14694
- <code>weight</code>
14695
- </td>
14696
- <td>
14697
- <code>int</code>
14408
+ <code><autoref identifier="int" optional>int</autoref></code>
14698
14409
  </td>
14699
14410
  <td>
14700
14411
  <div class="doc-md-description">
@@ -14734,7 +14445,7 @@ the display text and the weight defines its position in the navbar.</p>
14734
14445
  <div class="doc doc-contents ">
14735
14446
 
14736
14447
 
14737
- <p>Base class for UI framework definition of the contents of an Object Detail (Object Retrieve) page.</p>
14448
+ <p>Base class for UI framework definition of the contents of an Object Detail (Object Retrieve) page.</p>
14738
14449
  <p>This currently defines the tabs and their panel contents, but does NOT describe the page title, breadcrumbs, etc.</p>
14739
14450
  <p>Basic usage for a <code>NautobotUIViewSet</code> looks like:</p>
14740
14451
  <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="nn">nautobot.apps.ui</span> <span class="kn">import</span> <span class="n">ObjectDetailContent</span><span class="p">,</span> <span class="n">ObjectFieldsPanel</span><span class="p">,</span> <span class="n">SectionChoices</span>
@@ -14751,11 +14462,6 @@ the display text and the weight defines its position in the navbar.</p>
14751
14462
 
14752
14463
 
14753
14464
 
14754
-
14755
-
14756
-
14757
-
14758
-
14759
14465
  <div class="doc doc-children">
14760
14466
 
14761
14467
 
@@ -14781,7 +14487,7 @@ the display text and the weight defines its position in the navbar.</p>
14781
14487
 
14782
14488
  <div class="doc doc-contents ">
14783
14489
 
14784
- <p>The extra buttons defined for this detail view, ordered by their <code>weight</code>.</p>
14490
+ <p>The extra buttons defined for this detail view, ordered by their <code>weight</code>.</p>
14785
14491
  </div>
14786
14492
 
14787
14493
  </div>
@@ -14803,7 +14509,7 @@ the display text and the weight defines its position in the navbar.</p>
14803
14509
 
14804
14510
  <div class="doc doc-contents ">
14805
14511
 
14806
- <p>The tabs defined for this detail view, ordered by their <code>weight</code>.</p>
14512
+ <p>The tabs defined for this detail view, ordered by their <code>weight</code>.</p>
14807
14513
  </div>
14808
14514
 
14809
14515
  </div>
@@ -14821,7 +14527,7 @@ the display text and the weight defines its position in the navbar.</p>
14821
14527
 
14822
14528
  <div class="doc doc-contents ">
14823
14529
 
14824
- <p>Create an ObjectDetailContent with a "main" tab and all standard "extras" tabs (advanced, contacts, etc.).</p>
14530
+ <p>Create an ObjectDetailContent with a "main" tab and all standard "extras" tabs (advanced, contacts, etc.).</p>
14825
14531
 
14826
14532
 
14827
14533
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -14836,11 +14542,9 @@ the display text and the weight defines its position in the navbar.</p>
14836
14542
  </thead>
14837
14543
  <tbody>
14838
14544
  <tr class="doc-section-item">
14545
+ <td><code>panels</code></td>
14839
14546
  <td>
14840
- <code>panels</code>
14841
- </td>
14842
- <td>
14843
- <code>list</code>
14547
+ <code><autoref identifier="list" optional>list</autoref></code>
14844
14548
  </td>
14845
14549
  <td>
14846
14550
  <div class="doc-md-description">
@@ -14853,11 +14557,9 @@ the display text and the weight defines its position in the navbar.</p>
14853
14557
  </td>
14854
14558
  </tr>
14855
14559
  <tr class="doc-section-item">
14560
+ <td><code>layout</code></td>
14856
14561
  <td>
14857
- <code>layout</code>
14858
- </td>
14859
- <td>
14860
- <code>str</code>
14562
+ <code><autoref identifier="str" optional>str</autoref></code>
14861
14563
  </td>
14862
14564
  <td>
14863
14565
  <div class="doc-md-description">
@@ -14865,15 +14567,13 @@ the display text and the weight defines its position in the navbar.</p>
14865
14567
  </div>
14866
14568
  </td>
14867
14569
  <td>
14868
- <code><span title="nautobot.core.ui.choices.LayoutChoices.DEFAULT">DEFAULT</span></code>
14570
+ <code><autoref identifier="nautobot.core.ui.choices.LayoutChoices.DEFAULT" optional hover>DEFAULT</autoref></code>
14869
14571
  </td>
14870
14572
  </tr>
14871
14573
  <tr class="doc-section-item">
14574
+ <td><code>extra_buttons</code></td>
14872
14575
  <td>
14873
- <code>extra_buttons</code>
14874
- </td>
14875
- <td>
14876
- <code>list</code>
14576
+ <code><autoref identifier="list" optional>list</autoref></code>
14877
14577
  </td>
14878
14578
  <td>
14879
14579
  <div class="doc-md-description">
@@ -14886,11 +14586,9 @@ the display text and the weight defines its position in the navbar.</p>
14886
14586
  </td>
14887
14587
  </tr>
14888
14588
  <tr class="doc-section-item">
14589
+ <td><code>extra_tabs</code></td>
14889
14590
  <td>
14890
- <code>extra_tabs</code>
14891
- </td>
14892
- <td>
14893
- <code>list</code>
14591
+ <code><autoref identifier="list" optional>list</autoref></code>
14894
14592
  </td>
14895
14593
  <td>
14896
14594
  <div class="doc-md-description">
@@ -14930,15 +14628,10 @@ dynamic-groups, metadata, etc.) do not need to be specified as they will be auto
14930
14628
 
14931
14629
  <div class="doc doc-contents ">
14932
14630
  <p class="doc doc-class-bases">
14933
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.KeyValueTablePanel" href="#nautobot.apps.ui.KeyValueTablePanel">KeyValueTablePanel</a></code></p>
14934
-
14935
-
14936
- <p>A panel that renders a table of object instance attributes and their values.</p>
14937
-
14938
-
14939
-
14631
+ Bases: <code><autoref identifier="nautobot.core.ui.object_detail.KeyValueTablePanel" optional hover>KeyValueTablePanel</autoref></code></p>
14940
14632
 
14941
14633
 
14634
+ <p>A panel that renders a table of object instance attributes and their values.</p>
14942
14635
 
14943
14636
 
14944
14637
 
@@ -14964,7 +14657,7 @@ dynamic-groups, metadata, etc.) do not need to be specified as they will be auto
14964
14657
 
14965
14658
  <div class="doc doc-contents ">
14966
14659
 
14967
- <p>Instantiate an ObjectFieldsPanel.</p>
14660
+ <p>Instantiate an ObjectFieldsPanel.</p>
14968
14661
 
14969
14662
 
14970
14663
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -14979,11 +14672,9 @@ dynamic-groups, metadata, etc.) do not need to be specified as they will be auto
14979
14672
  </thead>
14980
14673
  <tbody>
14981
14674
  <tr class="doc-section-item">
14675
+ <td><code>fields</code></td>
14982
14676
  <td>
14983
- <code>fields</code>
14984
- </td>
14985
- <td>
14986
- <code>(str, list)</code>
14677
+ <code>(<autoref identifier="str" optional>str</autoref>, <autoref identifier="list" optional>list</autoref>)</code>
14987
14678
  </td>
14988
14679
  <td>
14989
14680
  <div class="doc-md-description">
@@ -14997,11 +14688,9 @@ are any hidden fields, nor the specially handled <code>id</code>, <code>created<
14997
14688
  </td>
14998
14689
  </tr>
14999
14690
  <tr class="doc-section-item">
14691
+ <td><code>exclude_fields</code></td>
15000
14692
  <td>
15001
- <code>exclude_fields</code>
15002
- </td>
15003
- <td>
15004
- <code>list</code>
14693
+ <code><autoref identifier="list" optional>list</autoref></code>
15005
14694
  </td>
15006
14695
  <td>
15007
14696
  <div class="doc-md-description">
@@ -15013,11 +14702,9 @@ are any hidden fields, nor the specially handled <code>id</code>, <code>created<
15013
14702
  </td>
15014
14703
  </tr>
15015
14704
  <tr class="doc-section-item">
14705
+ <td><code>context_object_key</code></td>
15016
14706
  <td>
15017
- <code>context_object_key</code>
15018
- </td>
15019
- <td>
15020
- <code>str</code>
14707
+ <code><autoref identifier="str" optional>str</autoref></code>
15021
14708
  </td>
15022
14709
  <td>
15023
14710
  <div class="doc-md-description">
@@ -15029,11 +14716,9 @@ are any hidden fields, nor the specially handled <code>id</code>, <code>created<
15029
14716
  </td>
15030
14717
  </tr>
15031
14718
  <tr class="doc-section-item">
14719
+ <td><code>ignore_nonexistent_fields</code></td>
15032
14720
  <td>
15033
- <code>ignore_nonexistent_fields</code>
15034
- </td>
15035
- <td>
15036
- <code>bool</code>
14721
+ <code><autoref identifier="bool" optional>bool</autoref></code>
15037
14722
  </td>
15038
14723
  <td>
15039
14724
  <div class="doc-md-description">
@@ -15046,11 +14731,9 @@ exist on the provided object; otherwise an exception will be raised at render ti
15046
14731
  </td>
15047
14732
  </tr>
15048
14733
  <tr class="doc-section-item">
14734
+ <td><code>label</code></td>
15049
14735
  <td>
15050
- <code>label</code>
15051
- </td>
15052
- <td>
15053
- <code>str</code>
14736
+ <code><autoref identifier="str" optional>str</autoref></code>
15054
14737
  </td>
15055
14738
  <td>
15056
14739
  <div class="doc-md-description">
@@ -15080,7 +14763,7 @@ exist on the provided object; otherwise an exception will be raised at render ti
15080
14763
 
15081
14764
  <div class="doc doc-contents ">
15082
14765
 
15083
- <p>Load data from the object provided in the render context based on the given set of <code>fields</code>.</p>
14766
+ <p>Load data from the object provided in the render context based on the given set of <code>fields</code>.</p>
15084
14767
 
15085
14768
 
15086
14769
  <p><span class="doc-section-title">Returns:</span></p>
@@ -15094,7 +14777,7 @@ exist on the provided object; otherwise an exception will be raised at render ti
15094
14777
  <tbody>
15095
14778
  <tr class="doc-section-item">
15096
14779
  <td>
15097
- <code>dict</code>
14780
+ <code><autoref identifier="dict" optional>dict</autoref></code>
15098
14781
  </td>
15099
14782
  <td>
15100
14783
  <div class="doc-md-description">
@@ -15120,7 +14803,7 @@ exist on the provided object; otherwise an exception will be raised at render ti
15120
14803
 
15121
14804
  <div class="doc doc-contents ">
15122
14805
 
15123
- <p>Render the <code>verbose_name</code> of the model field whose name corresponds to the given key, if applicable.</p>
14806
+ <p>Render the <code>verbose_name</code> of the model field whose name corresponds to the given key, if applicable.</p>
15124
14807
 
15125
14808
  </div>
15126
14809
 
@@ -15137,7 +14820,7 @@ exist on the provided object; otherwise an exception will be raised at render ti
15137
14820
 
15138
14821
  <div class="doc doc-contents ">
15139
14822
 
15140
- <p>Default to rendering the provided object's <code>verbose_name</code> if no more specific <code>label</code> was defined.</p>
14823
+ <p>Default to rendering the provided object's <code>verbose_name</code> if no more specific <code>label</code> was defined.</p>
15141
14824
 
15142
14825
  </div>
15143
14826
 
@@ -15164,10 +14847,10 @@ exist on the provided object; otherwise an exception will be raised at render ti
15164
14847
 
15165
14848
  <div class="doc doc-contents ">
15166
14849
  <p class="doc doc-class-bases">
15167
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.BaseTextPanel" href="#nautobot.apps.ui.BaseTextPanel">BaseTextPanel</a></code></p>
14850
+ Bases: <code><autoref identifier="nautobot.core.ui.object_detail.BaseTextPanel" optional hover>BaseTextPanel</autoref></code></p>
15168
14851
 
15169
14852
 
15170
- <p>Panel that renders text, Markdown, JSON or YAML from the given field on the given object in the context.</p>
14853
+ <p>Panel that renders text, Markdown, JSON or YAML from the given field on the given object in the context.</p>
15171
14854
 
15172
14855
 
15173
14856
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -15182,11 +14865,9 @@ exist on the provided object; otherwise an exception will be raised at render ti
15182
14865
  </thead>
15183
14866
  <tbody>
15184
14867
  <tr class="doc-section-item">
14868
+ <td><code>object_field</code></td>
15185
14869
  <td>
15186
- <code>object_field</code>
15187
- </td>
15188
- <td>
15189
- <code>str</code>
14870
+ <code><autoref identifier="str" optional>str</autoref></code>
15190
14871
  </td>
15191
14872
  <td>
15192
14873
  <div class="doc-md-description">
@@ -15198,11 +14879,9 @@ exist on the provided object; otherwise an exception will be raised at render ti
15198
14879
  </td>
15199
14880
  </tr>
15200
14881
  <tr class="doc-section-item">
14882
+ <td><code>kwargs</code></td>
15201
14883
  <td>
15202
- <code>kwargs</code>
15203
- </td>
15204
- <td>
15205
- <code>dict</code>
14884
+ <code><autoref identifier="dict" optional>dict</autoref></code>
15206
14885
  </td>
15207
14886
  <td>
15208
14887
  <div class="doc-md-description">
@@ -15219,11 +14898,6 @@ exist on the provided object; otherwise an exception will be raised at render ti
15219
14898
 
15220
14899
 
15221
14900
 
15222
-
15223
-
15224
-
15225
-
15226
-
15227
14901
  <div class="doc doc-children">
15228
14902
 
15229
14903
 
@@ -15255,23 +14929,10 @@ exist on the provided object; otherwise an exception will be raised at render ti
15255
14929
 
15256
14930
  <div class="doc doc-contents ">
15257
14931
  <p class="doc doc-class-bases">
15258
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.Panel" href="#nautobot.apps.ui.Panel">Panel</a></code></p>
15259
-
15260
-
15261
- <p>A panel that renders a Table of objects (typically related objects, rather than the "main" object of a view).
15262
- Has built-in pagination support and "Add" button at bottom of the Table.</p>
15263
- <p>It renders the django-tables2 classes with Nautobot additions. You can pass the instance of Table Class
15264
- already configured in context and set the <code>context_table_key</code> or pass a Table Class to <code>__init__</code> via <code>table_class</code>.</p>
15265
- <p>When <code>table_class</code> is set, you need to pass <code>table_filter</code> or <code>table_attribute</code> for fetching data purpose.</p>
15266
- <p>Data fetching can be optimized by using <code>select_related_fields</code>, <code>prefetch_related_fields</code>.</p>
15267
- <p>How Table is displayed can be changed by using <code>include_columns</code>, <code>exclude_columns</code>, <code>table_title</code>,
15268
- <code>hide_hierarchy_ui</code>, <code>related_field_name</code> or <code>enable_bulk_actions</code>.</p>
15269
- <p>Please check the Args list for further details.</p>
15270
-
15271
-
15272
-
14932
+ Bases: <code><autoref identifier="nautobot.core.ui.object_detail.Panel" optional hover>Panel</autoref></code></p>
15273
14933
 
15274
14934
 
14935
+ <p>A panel that renders a Table of objects (typically related objects, rather than the "main" object of a view).</p>
15275
14936
 
15276
14937
 
15277
14938
 
@@ -15297,7 +14958,7 @@ already configured in context and set the <code>context_table_key</code> or pass
15297
14958
 
15298
14959
  <div class="doc doc-contents ">
15299
14960
 
15300
- <p>Instantiate an ObjectsTable panel.</p>
14961
+ <p>Instantiate an ObjectsTable panel.</p>
15301
14962
 
15302
14963
 
15303
14964
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -15312,11 +14973,9 @@ already configured in context and set the <code>context_table_key</code> or pass
15312
14973
  </thead>
15313
14974
  <tbody>
15314
14975
  <tr class="doc-section-item">
14976
+ <td><code>context_table_key</code></td>
15315
14977
  <td>
15316
- <code>context_table_key</code>
15317
- </td>
15318
- <td>
15319
- <code>str</code>
14978
+ <code><autoref identifier="str" optional>str</autoref></code>
15320
14979
  </td>
15321
14980
  <td>
15322
14981
  <div class="doc-md-description">
@@ -15329,11 +14988,9 @@ Table (<code>BaseTable</code>) instance. Mutually exclusive with <code>table_cla
15329
14988
  </td>
15330
14989
  </tr>
15331
14990
  <tr class="doc-section-item">
14991
+ <td><code>table_class</code></td>
15332
14992
  <td>
15333
- <code>table_class</code>
15334
- </td>
15335
- <td>
15336
- <code>obj</code>
14993
+ <code><autoref identifier="obj" optional>obj</autoref></code>
15337
14994
  </td>
15338
14995
  <td>
15339
14996
  <div class="doc-md-description">
@@ -15346,11 +15003,9 @@ Mutually exclusive with <code>context_table_key</code>.</p>
15346
15003
  </td>
15347
15004
  </tr>
15348
15005
  <tr class="doc-section-item">
15006
+ <td><code>table_filter</code></td>
15349
15007
  <td>
15350
- <code>table_filter</code>
15351
- </td>
15352
- <td>
15353
- <code>str</code>
15008
+ <code><autoref identifier="str" optional>str</autoref></code>
15354
15009
  </td>
15355
15010
  <td>
15356
15011
  <div class="doc-md-description">
@@ -15365,11 +15020,9 @@ Mutually exclusive with <code>table_attribute</code>.</p>
15365
15020
  </td>
15366
15021
  </tr>
15367
15022
  <tr class="doc-section-item">
15023
+ <td><code>table_attribute</code></td>
15368
15024
  <td>
15369
- <code>table_attribute</code>
15370
- </td>
15371
- <td>
15372
- <code>str</code>
15025
+ <code><autoref identifier="str" optional>str</autoref></code>
15373
15026
  </td>
15374
15027
  <td>
15375
15028
  <div class="doc-md-description">
@@ -15383,11 +15036,9 @@ Mutually exclusive with <code>table_filter</code>.</p>
15383
15036
  </td>
15384
15037
  </tr>
15385
15038
  <tr class="doc-section-item">
15039
+ <td><code>select_related_fields</code></td>
15386
15040
  <td>
15387
- <code>select_related_fields</code>
15388
- </td>
15389
- <td>
15390
- <code>list</code>
15041
+ <code><autoref identifier="list" optional>list</autoref></code>
15391
15042
  </td>
15392
15043
  <td>
15393
15044
  <div class="doc-md-description">
@@ -15399,11 +15050,9 @@ Mutually exclusive with <code>table_filter</code>.</p>
15399
15050
  </td>
15400
15051
  </tr>
15401
15052
  <tr class="doc-section-item">
15053
+ <td><code>prefetch_related_fields</code></td>
15402
15054
  <td>
15403
- <code>prefetch_related_fields</code>
15404
- </td>
15405
- <td>
15406
- <code>list</code>
15055
+ <code><autoref identifier="list" optional>list</autoref></code>
15407
15056
  </td>
15408
15057
  <td>
15409
15058
  <div class="doc-md-description">
@@ -15416,11 +15065,9 @@ method.</p>
15416
15065
  </td>
15417
15066
  </tr>
15418
15067
  <tr class="doc-section-item">
15068
+ <td><code>order_by_fields</code></td>
15419
15069
  <td>
15420
- <code>order_by_fields</code>
15421
- </td>
15422
- <td>
15423
- <code>list</code>
15070
+ <code><autoref identifier="list" optional>list</autoref></code>
15424
15071
  </td>
15425
15072
  <td>
15426
15073
  <div class="doc-md-description">
@@ -15432,11 +15079,9 @@ method.</p>
15432
15079
  </td>
15433
15080
  </tr>
15434
15081
  <tr class="doc-section-item">
15082
+ <td><code>max_display_count</code></td>
15435
15083
  <td>
15436
- <code>max_display_count</code>
15437
- </td>
15438
- <td>
15439
- <code>int</code>
15084
+ <code><autoref identifier="int" optional>int</autoref></code>
15440
15085
  </td>
15441
15086
  <td>
15442
15087
  <div class="doc-md-description">
@@ -15449,11 +15094,9 @@ If None, defaults to the <code>get_paginate_count()</code> (which is user's pref
15449
15094
  </td>
15450
15095
  </tr>
15451
15096
  <tr class="doc-section-item">
15097
+ <td><code>table_title</code></td>
15452
15098
  <td>
15453
- <code>table_title</code>
15454
- </td>
15455
- <td>
15456
- <code>str</code>
15099
+ <code><autoref identifier="str" optional>str</autoref></code>
15457
15100
  </td>
15458
15101
  <td>
15459
15102
  <div class="doc-md-description">
@@ -15466,11 +15109,9 @@ If None, defaults to the plural verbose name of the table model.</p>
15466
15109
  </td>
15467
15110
  </tr>
15468
15111
  <tr class="doc-section-item">
15112
+ <td><code>include_columns</code></td>
15469
15113
  <td>
15470
- <code>include_columns</code>
15471
- </td>
15472
- <td>
15473
- <code>list</code>
15114
+ <code><autoref identifier="list" optional>list</autoref></code>
15474
15115
  </td>
15475
15116
  <td>
15476
15117
  <div class="doc-md-description">
@@ -15483,11 +15124,9 @@ If provided, only these fields will be displayed in the table.</p>
15483
15124
  </td>
15484
15125
  </tr>
15485
15126
  <tr class="doc-section-item">
15127
+ <td><code>exclude_columns</code></td>
15486
15128
  <td>
15487
- <code>exclude_columns</code>
15488
- </td>
15489
- <td>
15490
- <code>list</code>
15129
+ <code><autoref identifier="list" optional>list</autoref></code>
15491
15130
  </td>
15492
15131
  <td>
15493
15132
  <div class="doc-md-description">
@@ -15500,11 +15139,9 @@ Mutually exclusive with <code>include_columns</code>.</p>
15500
15139
  </td>
15501
15140
  </tr>
15502
15141
  <tr class="doc-section-item">
15142
+ <td><code>add_button_route</code></td>
15503
15143
  <td>
15504
- <code>add_button_route</code>
15505
- </td>
15506
- <td>
15507
- <code>str</code>
15144
+ <code><autoref identifier="str" optional>str</autoref></code>
15508
15145
  </td>
15509
15146
  <td>
15510
15147
  <div class="doc-md-description">
@@ -15517,11 +15154,9 @@ which uses the default table's model <code>add</code> route.</p>
15517
15154
  </td>
15518
15155
  </tr>
15519
15156
  <tr class="doc-section-item">
15157
+ <td><code>add_permissions</code></td>
15520
15158
  <td>
15521
- <code>add_permissions</code>
15522
- </td>
15523
- <td>
15524
- <code>list</code>
15159
+ <code><autoref identifier="list" optional>list</autoref></code>
15525
15160
  </td>
15526
15161
  <td>
15527
15162
  <div class="doc-md-description">
@@ -15534,11 +15169,9 @@ If not provided, permissions are determined by default based on the model.</p>
15534
15169
  </td>
15535
15170
  </tr>
15536
15171
  <tr class="doc-section-item">
15172
+ <td><code>hide_hierarchy_ui</code></td>
15537
15173
  <td>
15538
- <code>hide_hierarchy_ui</code>
15539
- </td>
15540
- <td>
15541
- <code>bool</code>
15174
+ <code><autoref identifier="bool" optional>bool</autoref></code>
15542
15175
  </td>
15543
15176
  <td>
15544
15177
  <div class="doc-md-description">
@@ -15550,11 +15183,9 @@ If not provided, permissions are determined by default based on the model.</p>
15550
15183
  </td>
15551
15184
  </tr>
15552
15185
  <tr class="doc-section-item">
15186
+ <td><code>related_field_name</code></td>
15553
15187
  <td>
15554
- <code>related_field_name</code>
15555
- </td>
15556
- <td>
15557
- <code>str</code>
15188
+ <code><autoref identifier="str" optional>str</autoref></code>
15558
15189
  </td>
15559
15190
  <td>
15560
15191
  <div class="doc-md-description">
@@ -15567,11 +15198,9 @@ to the base model. Defaults to the same as <code>table_filter</code> if unset. U
15567
15198
  </td>
15568
15199
  </tr>
15569
15200
  <tr class="doc-section-item">
15201
+ <td><code>enable_bulk_actions</code></td>
15570
15202
  <td>
15571
- <code>enable_bulk_actions</code>
15572
- </td>
15573
- <td>
15574
- <code>bool</code>
15203
+ <code><autoref identifier="bool" optional>bool</autoref></code>
15575
15204
  </td>
15576
15205
  <td>
15577
15206
  <div class="doc-md-description">
@@ -15601,7 +15230,7 @@ appropriate permissions.</p>
15601
15230
 
15602
15231
  <div class="doc doc-contents ">
15603
15232
 
15604
- <p>Add additional context for rendering the table panel.</p>
15233
+ <p>Add additional context for rendering the table panel.</p>
15605
15234
  <p>This method processes the table data, configures pagination, and generates URLs
15606
15235
  for listing and adding objects. It also handles field inclusion/exclusion and
15607
15236
  displays the appropriate table title if provided.</p>
@@ -15631,15 +15260,10 @@ displays the appropriate table title if provided.</p>
15631
15260
 
15632
15261
  <div class="doc doc-contents ">
15633
15262
  <p class="doc doc-class-bases">
15634
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.Component" href="#nautobot.apps.ui.Component">Component</a></code></p>
15635
-
15636
-
15637
- <p>Base class for defining an individual display panel within a Layout within a Tab.</p>
15638
-
15639
-
15640
-
15263
+ Bases: <code><autoref identifier="nautobot.core.ui.object_detail.Component" optional hover>Component</autoref></code></p>
15641
15264
 
15642
15265
 
15266
+ <p>Base class for defining an individual display panel within a Layout within a Tab.</p>
15643
15267
 
15644
15268
 
15645
15269
 
@@ -15665,7 +15289,7 @@ displays the appropriate table title if provided.</p>
15665
15289
 
15666
15290
  <div class="doc doc-contents ">
15667
15291
 
15668
- <p>Initialize a Panel component that can be rendered as a self-contained HTML fragment.</p>
15292
+ <p>Initialize a Panel component that can be rendered as a self-contained HTML fragment.</p>
15669
15293
 
15670
15294
 
15671
15295
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -15680,11 +15304,9 @@ displays the appropriate table title if provided.</p>
15680
15304
  </thead>
15681
15305
  <tbody>
15682
15306
  <tr class="doc-section-item">
15307
+ <td><code>label</code></td>
15683
15308
  <td>
15684
- <code>label</code>
15685
- </td>
15686
- <td>
15687
- <code>str</code>
15309
+ <code><autoref identifier="str" optional>str</autoref></code>
15688
15310
  </td>
15689
15311
  <td>
15690
15312
  <div class="doc-md-description">
@@ -15696,11 +15318,9 @@ displays the appropriate table title if provided.</p>
15696
15318
  </td>
15697
15319
  </tr>
15698
15320
  <tr class="doc-section-item">
15321
+ <td><code>section</code></td>
15699
15322
  <td>
15700
- <code>section</code>
15701
- </td>
15702
- <td>
15703
- <code>str</code>
15323
+ <code><autoref identifier="str" optional>str</autoref></code>
15704
15324
  </td>
15705
15325
  <td>
15706
15326
  <div class="doc-md-description">
@@ -15708,15 +15328,13 @@ displays the appropriate table title if provided.</p>
15708
15328
  </div>
15709
15329
  </td>
15710
15330
  <td>
15711
- <code><span title="nautobot.core.ui.choices.SectionChoices.FULL_WIDTH">FULL_WIDTH</span></code>
15331
+ <code><autoref identifier="nautobot.core.ui.choices.SectionChoices.FULL_WIDTH" optional hover>FULL_WIDTH</autoref></code>
15712
15332
  </td>
15713
15333
  </tr>
15714
15334
  <tr class="doc-section-item">
15335
+ <td><code>body_id</code></td>
15715
15336
  <td>
15716
- <code>body_id</code>
15717
- </td>
15718
- <td>
15719
- <code>str</code>
15337
+ <code><autoref identifier="str" optional>str</autoref></code>
15720
15338
  </td>
15721
15339
  <td>
15722
15340
  <div class="doc-md-description">
@@ -15728,11 +15346,9 @@ displays the appropriate table title if provided.</p>
15728
15346
  </td>
15729
15347
  </tr>
15730
15348
  <tr class="doc-section-item">
15349
+ <td><code>body_content_template_path</code></td>
15731
15350
  <td>
15732
- <code>body_content_template_path</code>
15733
- </td>
15734
- <td>
15735
- <code>str</code>
15351
+ <code><autoref identifier="str" optional>str</autoref></code>
15736
15352
  </td>
15737
15353
  <td>
15738
15354
  <div class="doc-md-description">
@@ -15744,11 +15360,9 @@ displays the appropriate table title if provided.</p>
15744
15360
  </td>
15745
15361
  </tr>
15746
15362
  <tr class="doc-section-item">
15363
+ <td><code>header_extra_content_template_path</code></td>
15747
15364
  <td>
15748
- <code>header_extra_content_template_path</code>
15749
- </td>
15750
- <td>
15751
- <code>str</code>
15365
+ <code><autoref identifier="str" optional>str</autoref></code>
15752
15366
  </td>
15753
15367
  <td>
15754
15368
  <div class="doc-md-description">
@@ -15761,11 +15375,9 @@ if any, not including its label if any.</p>
15761
15375
  </td>
15762
15376
  </tr>
15763
15377
  <tr class="doc-section-item">
15378
+ <td><code>footer_content_template_path</code></td>
15764
15379
  <td>
15765
- <code>footer_content_template_path</code>
15766
- </td>
15767
- <td>
15768
- <code>str</code>
15380
+ <code><autoref identifier="str" optional>str</autoref></code>
15769
15381
  </td>
15770
15382
  <td>
15771
15383
  <div class="doc-md-description">
@@ -15777,11 +15389,9 @@ if any, not including its label if any.</p>
15777
15389
  </td>
15778
15390
  </tr>
15779
15391
  <tr class="doc-section-item">
15392
+ <td><code>template_path</code></td>
15780
15393
  <td>
15781
- <code>template_path</code>
15782
- </td>
15783
- <td>
15784
- <code>str</code>
15394
+ <code><autoref identifier="str" optional>str</autoref></code>
15785
15395
  </td>
15786
15396
  <td>
15787
15397
  <div class="doc-md-description">
@@ -15793,11 +15403,9 @@ if any, not including its label if any.</p>
15793
15403
  </td>
15794
15404
  </tr>
15795
15405
  <tr class="doc-section-item">
15406
+ <td><code>body_wrapper_template_path</code></td>
15796
15407
  <td>
15797
- <code>body_wrapper_template_path</code>
15798
- </td>
15799
- <td>
15800
- <code>str</code>
15408
+ <code><autoref identifier="str" optional>str</autoref></code>
15801
15409
  </td>
15802
15410
  <td>
15803
15411
  <div class="doc-md-description">
@@ -15827,7 +15435,7 @@ if any, not including its label if any.</p>
15827
15435
 
15828
15436
  <div class="doc doc-contents ">
15829
15437
 
15830
- <p>Render the panel as a whole.</p>
15438
+ <p>Render the panel as a whole.</p>
15831
15439
  <p>Default implementation calls <code>render_label()</code>, <code>render_header_extra_content()</code>, <code>render_body()</code>,
15832
15440
  and <code>render_footer_extra_content()</code>, then wraps them all into the templated defined by <code>self.template_path</code>.</p>
15833
15441
  <p>Typically you'll override one or more of the aforementioned methods in a subclass, rather than replacing this
@@ -15848,7 +15456,7 @@ entire method as a whole.</p>
15848
15456
 
15849
15457
  <div class="doc doc-contents ">
15850
15458
 
15851
- <p>Render the panel body <em>including its HTML wrapper element(s)</em>.</p>
15459
+ <p>Render the panel body <em>including its HTML wrapper element(s)</em>.</p>
15852
15460
  <p>Default implementation calls <code>render_body_content()</code> and wraps that in the template defined at
15853
15461
  <code>self.body_wrapper_template_path</code>.</p>
15854
15462
  <p>Normally you won't want to override this method in a subclass, instead overriding <code>render_body_content()</code>.</p>
@@ -15868,7 +15476,7 @@ entire method as a whole.</p>
15868
15476
 
15869
15477
  <div class="doc doc-contents ">
15870
15478
 
15871
- <p>Render the content to include in this panel's body.</p>
15479
+ <p>Render the content to include in this panel's body.</p>
15872
15480
  <p>Default implementation renders the template from <code>self.body_content_template_path</code> if any.</p>
15873
15481
 
15874
15482
  </div>
@@ -15886,7 +15494,7 @@ entire method as a whole.</p>
15886
15494
 
15887
15495
  <div class="doc doc-contents ">
15888
15496
 
15889
- <p>Render any non-default content to include in this panel's footer.</p>
15497
+ <p>Render any non-default content to include in this panel's footer.</p>
15890
15498
  <p>Default implementation renders the template from <code>self.footer_content_template_path</code> if any.</p>
15891
15499
 
15892
15500
  </div>
@@ -15904,7 +15512,7 @@ entire method as a whole.</p>
15904
15512
 
15905
15513
  <div class="doc doc-contents ">
15906
15514
 
15907
- <p>Render any additional (non-label) content to include in this panel's header.</p>
15515
+ <p>Render any additional (non-label) content to include in this panel's header.</p>
15908
15516
  <p>Default implementation renders the template from <code>self.header_extra_content_template_path</code> if any.</p>
15909
15517
 
15910
15518
  </div>
@@ -15922,7 +15530,7 @@ entire method as a whole.</p>
15922
15530
 
15923
15531
  <div class="doc doc-contents ">
15924
15532
 
15925
- <p>Render the label of this panel, if any.</p>
15533
+ <p>Render the label of this panel, if any.</p>
15926
15534
 
15927
15535
  </div>
15928
15536
 
@@ -15950,12 +15558,7 @@ entire method as a whole.</p>
15950
15558
  <div class="doc doc-contents ">
15951
15559
 
15952
15560
 
15953
- <p>Ensure permissions through init.</p>
15954
-
15955
-
15956
-
15957
-
15958
-
15561
+ <p>Ensure permissions through init.</p>
15959
15562
 
15960
15563
 
15961
15564
 
@@ -15981,7 +15584,7 @@ entire method as a whole.</p>
15981
15584
 
15982
15585
  <div class="doc doc-contents ">
15983
15586
 
15984
- <p>Ensure permissions.</p>
15587
+ <p>Ensure permissions.</p>
15985
15588
 
15986
15589
  </div>
15987
15590
 
@@ -16008,10 +15611,10 @@ entire method as a whole.</p>
16008
15611
 
16009
15612
  <div class="doc doc-contents ">
16010
15613
  <p class="doc doc-class-bases">
16011
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.choices.ChoiceSet" href="choices.html#nautobot.apps.choices.ChoiceSet">ChoiceSet</a></code></p>
15614
+ Bases: <code><autoref identifier="nautobot.core.choices.ChoiceSet" optional hover>ChoiceSet</autoref></code></p>
16012
15615
 
16013
15616
 
16014
- <p>Sections of a Layout to assign panels to. Placement of panels is determined by <a href="ui.html#nautobot.apps.ui.LayoutChoices"><code>LayoutChoices</code></a> set on <code>Tab.layout</code></p>
15617
+ <p>Sections of a Layout to assign panels to. Placement of panels is determined by <a href="ui.html#nautobot.apps.ui.LayoutChoices"><code>LayoutChoices</code></a> set on <code>Tab.layout</code></p>
16015
15618
 
16016
15619
 
16017
15620
  <p><span class="doc-section-title">Attributes:</span></p>
@@ -16025,9 +15628,9 @@ entire method as a whole.</p>
16025
15628
  </thead>
16026
15629
  <tbody>
16027
15630
  <tr class="doc-section-item">
16028
- <td><code><span title="nautobot.apps.ui.SectionChoices.LEFT_HALF">LEFT_HALF</span></code></td>
15631
+ <td><code><autoref identifier="nautobot.apps.ui.SectionChoices.LEFT_HALF" optional hover>LEFT_HALF</autoref></code></td>
16029
15632
  <td>
16030
- <code>str</code>
15633
+ <code><autoref identifier="str" optional>str</autoref></code>
16031
15634
  </td>
16032
15635
  <td>
16033
15636
  <div class="doc-md-description">
@@ -16036,9 +15639,9 @@ entire method as a whole.</p>
16036
15639
  </td>
16037
15640
  </tr>
16038
15641
  <tr class="doc-section-item">
16039
- <td><code><span title="nautobot.apps.ui.SectionChoices.RIGHT_HALF">RIGHT_HALF</span></code></td>
15642
+ <td><code><autoref identifier="nautobot.apps.ui.SectionChoices.RIGHT_HALF" optional hover>RIGHT_HALF</autoref></code></td>
16040
15643
  <td>
16041
- <code>str</code>
15644
+ <code><autoref identifier="str" optional>str</autoref></code>
16042
15645
  </td>
16043
15646
  <td>
16044
15647
  <div class="doc-md-description">
@@ -16047,9 +15650,9 @@ entire method as a whole.</p>
16047
15650
  </td>
16048
15651
  </tr>
16049
15652
  <tr class="doc-section-item">
16050
- <td><code><span title="nautobot.apps.ui.SectionChoices.FULL_WIDTH">FULL_WIDTH</span></code></td>
15653
+ <td><code><autoref identifier="nautobot.apps.ui.SectionChoices.FULL_WIDTH" optional hover>FULL_WIDTH</autoref></code></td>
16051
15654
  <td>
16052
- <code>str</code>
15655
+ <code><autoref identifier="str" optional>str</autoref></code>
16053
15656
  </td>
16054
15657
  <td>
16055
15658
  <div class="doc-md-description">
@@ -16063,11 +15666,6 @@ entire method as a whole.</p>
16063
15666
 
16064
15667
 
16065
15668
 
16066
-
16067
-
16068
-
16069
-
16070
-
16071
15669
  <div class="doc doc-children">
16072
15670
 
16073
15671
 
@@ -16099,12 +15697,7 @@ entire method as a whole.</p>
16099
15697
 
16100
15698
  <div class="doc doc-contents ">
16101
15699
  <p class="doc doc-class-bases">
16102
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.Panel" href="#nautobot.apps.ui.Panel">Panel</a></code></p>
16103
-
16104
-
16105
-
16106
-
16107
-
15700
+ Bases: <code><autoref identifier="nautobot.core.ui.object_detail.Panel" optional hover>Panel</autoref></code></p>
16108
15701
 
16109
15702
 
16110
15703
 
@@ -16131,7 +15724,7 @@ entire method as a whole.</p>
16131
15724
 
16132
15725
  <div class="doc doc-contents ">
16133
15726
 
16134
- <p>Instantiate a <code>StatsPanel</code>.
15727
+ <p>Instantiate a <code>StatsPanel</code>.
16135
15728
  filter_name (str) is a valid query filter append to the anchor tag for each stat button.
16136
15729
  e.g. the <code>tenant</code> query parameter in the url <code>/circuits/circuits/?tenant=f4b48e9d-56fc-4090-afa5-dcbe69775b13</code>.
16137
15730
  related_models is a list of model classes and/or tuples of (model_class, query_string).
@@ -16152,7 +15745,7 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
16152
15745
 
16153
15746
  <div class="doc doc-contents ">
16154
15747
 
16155
- <p>Transform self.related_models to a dictionary with key, value pairs as follows:
15748
+ <p>Transform self.related_models to a dictionary with key, value pairs as follows:
16156
15749
  {
16157
15750
  <related_object_model_class_1>: [related_object_model_class_list_url_1, related_object_count_1, related_object_title_1],
16158
15751
  <related_object_model_class_2>: [related_object_model_class_list_url_2, related_object_count_2, related_object_title_2],
@@ -16175,7 +15768,7 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
16175
15768
 
16176
15769
  <div class="doc doc-contents ">
16177
15770
 
16178
- <p>Always should render this panel as the permission is reinforced in python with .restrict(request.user, "view")</p>
15771
+ <p>Always should render this panel as the permission is reinforced in python with .restrict(request.user, "view")</p>
16179
15772
 
16180
15773
  </div>
16181
15774
 
@@ -16202,15 +15795,10 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
16202
15795
 
16203
15796
  <div class="doc doc-contents ">
16204
15797
  <p class="doc doc-class-bases">
16205
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.Component" href="#nautobot.apps.ui.Component">Component</a></code></p>
16206
-
16207
-
16208
- <p>Base class for UI framework definition of a single tabbed pane within an Object Detail (Object Retrieve) page.</p>
16209
-
16210
-
16211
-
15798
+ Bases: <code><autoref identifier="nautobot.core.ui.object_detail.Component" optional hover>Component</autoref></code></p>
16212
15799
 
16213
15800
 
15801
+ <p>Base class for UI framework definition of a single tabbed pane within an Object Detail (Object Retrieve) page.</p>
16214
15802
 
16215
15803
 
16216
15804
 
@@ -16236,7 +15824,7 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
16236
15824
 
16237
15825
  <div class="doc doc-contents ">
16238
15826
 
16239
- <p>Initialize a Tab component.</p>
15827
+ <p>Initialize a Tab component.</p>
16240
15828
 
16241
15829
 
16242
15830
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -16251,11 +15839,9 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
16251
15839
  </thead>
16252
15840
  <tbody>
16253
15841
  <tr class="doc-section-item">
15842
+ <td><code>tab_id</code></td>
16254
15843
  <td>
16255
- <code>tab_id</code>
16256
- </td>
16257
- <td>
16258
- <code>str</code>
15844
+ <code><autoref identifier="str" optional>str</autoref></code>
16259
15845
  </td>
16260
15846
  <td>
16261
15847
  <div class="doc-md-description">
@@ -16267,11 +15853,9 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
16267
15853
  </td>
16268
15854
  </tr>
16269
15855
  <tr class="doc-section-item">
15856
+ <td><code>label</code></td>
16270
15857
  <td>
16271
- <code>label</code>
16272
- </td>
16273
- <td>
16274
- <code>str</code>
15858
+ <code><autoref identifier="str" optional>str</autoref></code>
16275
15859
  </td>
16276
15860
  <td>
16277
15861
  <div class="doc-md-description">
@@ -16283,11 +15867,9 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
16283
15867
  </td>
16284
15868
  </tr>
16285
15869
  <tr class="doc-section-item">
15870
+ <td><code>panels</code></td>
16286
15871
  <td>
16287
- <code>panels</code>
16288
- </td>
16289
- <td>
16290
- <code>tuple</code>
15872
+ <code><autoref identifier="tuple" optional>tuple</autoref></code>
16291
15873
  </td>
16292
15874
  <td>
16293
15875
  <div class="doc-md-description">
@@ -16299,11 +15881,9 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
16299
15881
  </td>
16300
15882
  </tr>
16301
15883
  <tr class="doc-section-item">
15884
+ <td><code>layout</code></td>
16302
15885
  <td>
16303
- <code>layout</code>
16304
- </td>
16305
- <td>
16306
- <code>str</code>
15886
+ <code><autoref identifier="str" optional>str</autoref></code>
16307
15887
  </td>
16308
15888
  <td>
16309
15889
  <div class="doc-md-description">
@@ -16311,15 +15891,13 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
16311
15891
  </div>
16312
15892
  </td>
16313
15893
  <td>
16314
- <code><span title="nautobot.core.ui.choices.LayoutChoices.DEFAULT">DEFAULT</span></code>
15894
+ <code><autoref identifier="nautobot.core.ui.choices.LayoutChoices.DEFAULT" optional hover>DEFAULT</autoref></code>
16315
15895
  </td>
16316
15896
  </tr>
16317
15897
  <tr class="doc-section-item">
15898
+ <td><code>label_wrapper_template_path</code></td>
16318
15899
  <td>
16319
- <code>label_wrapper_template_path</code>
16320
- </td>
16321
- <td>
16322
- <code>str</code>
15900
+ <code><autoref identifier="str" optional>str</autoref></code>
16323
15901
  </td>
16324
15902
  <td>
16325
15903
  <div class="doc-md-description">
@@ -16331,11 +15909,9 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
16331
15909
  </td>
16332
15910
  </tr>
16333
15911
  <tr class="doc-section-item">
15912
+ <td><code>content_wrapper_template_path</code></td>
16334
15913
  <td>
16335
- <code>content_wrapper_template_path</code>
16336
- </td>
16337
- <td>
16338
- <code>str</code>
15914
+ <code><autoref identifier="str" optional>str</autoref></code>
16339
15915
  </td>
16340
15916
  <td>
16341
15917
  <div class="doc-md-description">
@@ -16364,7 +15940,7 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
16364
15940
 
16365
15941
  <div class="doc doc-contents ">
16366
15942
 
16367
- <p>Get the subset of this tab's panels that apply to the given layout section, ordered by their <code>weight</code>.</p>
15943
+ <p>Get the subset of this tab's panels that apply to the given layout section, ordered by their <code>weight</code>.</p>
16368
15944
 
16369
15945
 
16370
15946
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -16379,11 +15955,9 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
16379
15955
  </thead>
16380
15956
  <tbody>
16381
15957
  <tr class="doc-section-item">
15958
+ <td><code>section</code></td>
16382
15959
  <td>
16383
- <code>section</code>
16384
- </td>
16385
- <td>
16386
- <code>str</code>
15960
+ <code><autoref identifier="str" optional>str</autoref></code>
16387
15961
  </td>
16388
15962
  <td>
16389
15963
  <div class="doc-md-description">
@@ -16409,7 +15983,7 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
16409
15983
  <tbody>
16410
15984
  <tr class="doc-section-item">
16411
15985
  <td>
16412
- <code>list[<a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.Panel" href="#nautobot.apps.ui.Panel">Panel</a>]</code>
15986
+ <code><autoref identifier="list" optional>list</autoref>[<autoref identifier="nautobot.core.ui.object_detail.Panel" optional hover>Panel</autoref>]</code>
16413
15987
  </td>
16414
15988
  <td>
16415
15989
  <div class="doc-md-description">
@@ -16435,7 +16009,7 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
16435
16009
 
16436
16010
  <div class="doc doc-contents ">
16437
16011
 
16438
- <p>Render the tab's contents (layout and panels) to HTML.</p>
16012
+ <p>Render the tab's contents (layout and panels) to HTML.</p>
16439
16013
 
16440
16014
  </div>
16441
16015
 
@@ -16452,7 +16026,7 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
16452
16026
 
16453
16027
  <div class="doc doc-contents ">
16454
16028
 
16455
- <p>Render the tab's label text in a form suitable for display to the user.</p>
16029
+ <p>Render the tab's label text in a form suitable for display to the user.</p>
16456
16030
  <p>Defaults to just returning <code>self.label</code>, but may be overridden if context-specific formatting is needed.</p>
16457
16031
 
16458
16032
  </div>
@@ -16470,7 +16044,7 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
16470
16044
 
16471
16045
  <div class="doc doc-contents ">
16472
16046
 
16473
- <p>Render the tab's label (as opposed to its contents) and wrapping HTML elements.</p>
16047
+ <p>Render the tab's label (as opposed to its contents) and wrapping HTML elements.</p>
16474
16048
  <p>In most cases you should not need to override this method; override <code>render_label()</code> instead.</p>
16475
16049
 
16476
16050
  </div>
@@ -16499,7 +16073,7 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
16499
16073
  <div class="doc doc-contents ">
16500
16074
 
16501
16075
 
16502
- <p>This class is used to register App content to be injected into core Nautobot templates.</p>
16076
+ <p>This class is used to register App content to be injected into core Nautobot templates.</p>
16503
16077
  <p>It contains methods and attributes that may be overridden by App authors to return template content.</p>
16504
16078
  <p>The <code>model</code> attribute on the class defines the which model detail/list pages this class renders content for.
16505
16079
  It should be set as a string in the form <code>&lt;app_label&gt;.&lt;model_name&gt;</code>.</p>
@@ -16507,11 +16081,6 @@ It should be set as a string in the form <code>&lt;app_label&gt;.&lt;model_name&
16507
16081
 
16508
16082
 
16509
16083
 
16510
-
16511
-
16512
-
16513
-
16514
-
16515
16084
  <div class="doc doc-children">
16516
16085
 
16517
16086
 
@@ -16525,7 +16094,7 @@ It should be set as a string in the form <code>&lt;app_label&gt;.&lt;model_name&
16525
16094
 
16526
16095
 
16527
16096
  <h3 id="nautobot.apps.ui.TemplateExtension.model" class="doc doc-heading">
16528
- <code class="highlight language-python"><span class="n">model</span> <span class="o">=</span> <span class="kc">None</span></code>
16097
+ <code class="highlight language-python"><span class="n">model</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span></code>
16529
16098
 
16530
16099
  <span class="doc doc-labels">
16531
16100
  <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
@@ -16537,7 +16106,7 @@ It should be set as a string in the form <code>&lt;app_label&gt;.&lt;model_name&
16537
16106
 
16538
16107
  <div class="doc doc-contents ">
16539
16108
 
16540
- <p>The model (as a string in the form <code>&lt;app_label&gt;.&lt;model&gt;</code>) that this TemplateExtension subclass applies to.</p>
16109
+ <p>The model (as a string in the form <code>&lt;app_label&gt;.&lt;model&gt;</code>) that this TemplateExtension subclass applies to.</p>
16541
16110
  </div>
16542
16111
 
16543
16112
  </div>
@@ -16559,7 +16128,7 @@ It should be set as a string in the form <code>&lt;app_label&gt;.&lt;model_name&
16559
16128
 
16560
16129
  <div class="doc doc-contents ">
16561
16130
 
16562
- <p>List of Button instances to add to the specified model's detail view.</p>
16131
+ <p>List of Button instances to add to the specified model's detail view.</p>
16563
16132
  </div>
16564
16133
 
16565
16134
  </div>
@@ -16581,7 +16150,7 @@ It should be set as a string in the form <code>&lt;app_label&gt;.&lt;model_name&
16581
16150
 
16582
16151
  <div class="doc doc-contents ">
16583
16152
 
16584
- <p>List of Panel instances to add to the specified model's detail view.</p>
16153
+ <p>List of Panel instances to add to the specified model's detail view.</p>
16585
16154
  </div>
16586
16155
 
16587
16156
  </div>
@@ -16603,7 +16172,7 @@ It should be set as a string in the form <code>&lt;app_label&gt;.&lt;model_name&
16603
16172
 
16604
16173
  <div class="doc doc-contents ">
16605
16174
 
16606
- <p>List of Tab instances to add to the specified model's detail view.</p>
16175
+ <p>List of Tab instances to add to the specified model's detail view.</p>
16607
16176
  </div>
16608
16177
 
16609
16178
  </div>
@@ -16621,7 +16190,7 @@ It should be set as a string in the form <code>&lt;app_label&gt;.&lt;model_name&
16621
16190
 
16622
16191
  <div class="doc doc-contents ">
16623
16192
 
16624
- <p>Called automatically to instantiate a TemplateExtension with render context before calling <code>left_page()</code>, etc.</p>
16193
+ <p>Called automatically to instantiate a TemplateExtension with render context before calling <code>left_page()</code>, etc.</p>
16625
16194
  <p>The provided context typically includes the following keys:</p>
16626
16195
  <ul>
16627
16196
  <li>object - The object being viewed</li>
@@ -16645,7 +16214,7 @@ It should be set as a string in the form <code>&lt;app_label&gt;.&lt;model_name&
16645
16214
 
16646
16215
  <div class="doc doc-contents ">
16647
16216
 
16648
- <p>(Deprecated) Provide content that will be added to the existing list of buttons on the detail page view.</p>
16217
+ <p>(Deprecated) Provide content that will be added to the existing list of buttons on the detail page view.</p>
16649
16218
  <p>In Nautobot v2.4.0 and later, Apps can (should) instead register <code>Button</code> instances in <code>object_detail_buttons</code>,
16650
16219
  instead of implementing a <code>.buttons()</code> method.</p>
16651
16220
  <p>Content should be returned as an HTML string.
@@ -16666,7 +16235,7 @@ Note that content does not need to be marked as safe because this is automatical
16666
16235
 
16667
16236
  <div class="doc doc-contents ">
16668
16237
 
16669
- <p>(Deprecated) Provide a dict of tabs and associated views that will be added to the detail page view.</p>
16238
+ <p>(Deprecated) Provide a dict of tabs and associated views that will be added to the detail page view.</p>
16670
16239
  <p>In Nautobot v2.4.0 and later, Apps can (should) instead implement the <code>object_detail_tabs</code> attribute instead.</p>
16671
16240
  <p>Tabs will be ordered by their position in the list.</p>
16672
16241
  <p>Content should be returned as a list of dicts in the following format:
@@ -16697,7 +16266,7 @@ Note that content does not need to be marked as safe because this is automatical
16697
16266
 
16698
16267
  <div class="doc doc-contents ">
16699
16268
 
16700
- <p>(Deprecated) Provide content that will be rendered within the full width of the detail page view.</p>
16269
+ <p>(Deprecated) Provide content that will be rendered within the full width of the detail page view.</p>
16701
16270
  <p>In Nautobot v2.4.0 and later, Apps can (should) instead register <code>Panel</code> instances in <code>object_detail_panels</code>,
16702
16271
  instead of implementing a <code>.full_width_page()</code> method.</p>
16703
16272
  <p>Content should be returned as an HTML string.
@@ -16718,7 +16287,7 @@ Note that content does not need to be marked as safe because this is automatical
16718
16287
 
16719
16288
  <div class="doc doc-contents ">
16720
16289
 
16721
- <p>(Deprecated) Provide content that will be rendered on the left of the detail page view.</p>
16290
+ <p>(Deprecated) Provide content that will be rendered on the left of the detail page view.</p>
16722
16291
  <p>In Nautobot v2.4.0 and later, Apps can (should) instead register <code>Panel</code> instances in <code>object_detail_panels</code>,
16723
16292
  instead of implementing a <code>.left_page()</code> method.</p>
16724
16293
  <p>Content should be returned as an HTML string.
@@ -16739,7 +16308,7 @@ Note that content does not need to be marked as safe because this is automatical
16739
16308
 
16740
16309
  <div class="doc doc-contents ">
16741
16310
 
16742
- <p>Buttons that will be rendered and added to the existing list of buttons on the list page view. Content
16311
+ <p>Buttons that will be rendered and added to the existing list of buttons on the list page view. Content
16743
16312
  should be returned as an HTML string. Note that content does not need to be marked as safe because this is
16744
16313
  automatically handled.</p>
16745
16314
 
@@ -16758,7 +16327,7 @@ automatically handled.</p>
16758
16327
 
16759
16328
  <div class="doc doc-contents ">
16760
16329
 
16761
- <p>Convenience method for rendering the specified Django template using the default context data. An additional
16330
+ <p>Convenience method for rendering the specified Django template using the default context data. An additional
16762
16331
  context dictionary may be passed as <code>extra_context</code>.</p>
16763
16332
 
16764
16333
  </div>
@@ -16776,7 +16345,7 @@ context dictionary may be passed as <code>extra_context</code>.</p>
16776
16345
 
16777
16346
  <div class="doc doc-contents ">
16778
16347
 
16779
- <p>(Deprecated) Provide content that will be rendered on the right of the detail page view.</p>
16348
+ <p>(Deprecated) Provide content that will be rendered on the right of the detail page view.</p>
16780
16349
  <p>In Nautobot v2.4.0 and later, Apps can (should) instead register <code>Panel</code> instances in <code>object_detail_panels</code>,
16781
16350
  instead of implementing a <code>.right_page()</code> method.</p>
16782
16351
  <p>Content should be returned as an HTML string.
@@ -16807,10 +16376,10 @@ Note that content does not need to be marked as safe because this is automatical
16807
16376
 
16808
16377
  <div class="doc doc-contents ">
16809
16378
  <p class="doc doc-class-bases">
16810
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.BaseTextPanel" href="#nautobot.apps.ui.BaseTextPanel">BaseTextPanel</a></code></p>
16379
+ Bases: <code><autoref identifier="nautobot.core.ui.object_detail.BaseTextPanel" optional hover>BaseTextPanel</autoref></code></p>
16811
16380
 
16812
16381
 
16813
- <p>Panel that renders text, Markdown, JSON or YAML from the given value in the context.</p>
16382
+ <p>Panel that renders text, Markdown, JSON or YAML from the given value in the context.</p>
16814
16383
 
16815
16384
 
16816
16385
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -16825,11 +16394,9 @@ Note that content does not need to be marked as safe because this is automatical
16825
16394
  </thead>
16826
16395
  <tbody>
16827
16396
  <tr class="doc-section-item">
16397
+ <td><code>context_field</code></td>
16828
16398
  <td>
16829
- <code>context_field</code>
16830
- </td>
16831
- <td>
16832
- <code>str</code>
16399
+ <code><autoref identifier="str" optional>str</autoref></code>
16833
16400
  </td>
16834
16401
  <td>
16835
16402
  <div class="doc-md-description">
@@ -16841,11 +16408,9 @@ Note that content does not need to be marked as safe because this is automatical
16841
16408
  </td>
16842
16409
  </tr>
16843
16410
  <tr class="doc-section-item">
16411
+ <td><code>kwargs</code></td>
16844
16412
  <td>
16845
- <code>kwargs</code>
16846
- </td>
16847
- <td>
16848
- <code>dict</code>
16413
+ <code><autoref identifier="dict" optional>dict</autoref></code>
16849
16414
  </td>
16850
16415
  <td>
16851
16416
  <div class="doc-md-description">
@@ -16862,11 +16427,6 @@ Note that content does not need to be marked as safe because this is automatical
16862
16427
 
16863
16428
 
16864
16429
 
16865
-
16866
-
16867
-
16868
-
16869
-
16870
16430
  <div class="doc doc-children">
16871
16431
 
16872
16432
 
@@ -16897,7 +16457,7 @@ Note that content does not need to be marked as safe because this is automatical
16897
16457
 
16898
16458
  <div class="doc doc-contents ">
16899
16459
 
16900
- <p>Render the template located at the given path with the given context, possibly augmented via additional kwargs.</p>
16460
+ <p>Render the template located at the given path with the given context, possibly augmented via additional kwargs.</p>
16901
16461
 
16902
16462
 
16903
16463
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -16912,11 +16472,9 @@ Note that content does not need to be marked as safe because this is automatical
16912
16472
  </thead>
16913
16473
  <tbody>
16914
16474
  <tr class="doc-section-item">
16475
+ <td><code>template_path</code></td>
16915
16476
  <td>
16916
- <code>template_path</code>
16917
- </td>
16918
- <td>
16919
- <code>str</code>
16477
+ <code><autoref identifier="str" optional>str</autoref></code>
16920
16478
  </td>
16921
16479
  <td>
16922
16480
  <div class="doc-md-description">
@@ -16928,11 +16486,9 @@ Note that content does not need to be marked as safe because this is automatical
16928
16486
  </td>
16929
16487
  </tr>
16930
16488
  <tr class="doc-section-item">
16489
+ <td><code>context</code></td>
16931
16490
  <td>
16932
- <code>context</code>
16933
- </td>
16934
- <td>
16935
- <code><span title="django.template.Context">Context</span></code>
16491
+ <code><autoref identifier="django.template.Context" optional hover>Context</autoref></code>
16936
16492
  </td>
16937
16493
  <td>
16938
16494
  <div class="doc-md-description">
@@ -16944,11 +16500,9 @@ Note that content does not need to be marked as safe because this is automatical
16944
16500
  </td>
16945
16501
  </tr>
16946
16502
  <tr class="doc-section-item">
16503
+ <td><code>**kwargs</code></td>
16947
16504
  <td>
16948
- <code>**kwargs</code>
16949
- </td>
16950
- <td>
16951
- <code>dict</code>
16505
+ <code><autoref identifier="dict" optional>dict</autoref></code>
16952
16506
  </td>
16953
16507
  <td>
16954
16508
  <div class="doc-md-description">
@@ -17124,7 +16678,7 @@ Note that content does not need to be marked as safe because this is automatical
17124
16678
  <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>
17125
16679
 
17126
16680
 
17127
- <script src="../../../assets/javascripts/bundle.88dd0f4e.min.js"></script>
16681
+ <script src="../../../assets/javascripts/bundle.83f73b43.min.js"></script>
17128
16682
 
17129
16683
  <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
17130
16684