From 57bb7c0a8eb8992aeb773046a62c75c511ae016d Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 29 Aug 2025 13:51:49 -0400 Subject: [PATCH 1/3] Split mkdocstrings-python into explicit dependency to force updates --- base_requirements.txt | 6 +++++- requirements.txt | 3 ++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/base_requirements.txt b/base_requirements.txt index 8d74ede6c..9bf8680a5 100644 --- a/base_requirements.txt +++ b/base_requirements.txt @@ -106,7 +106,11 @@ mkdocs-material # Introspection for embedded code # https://github.com/mkdocstrings/mkdocstrings/blob/main/CHANGELOG.md -mkdocstrings[python] +mkdocstrings + +# Python handler for mkdocstrings +# https://github.com/mkdocstrings/python/blob/main/CHANGELOG.md +mkdocstrings-python # Library for manipulating IP prefixes and addresses # https://github.com/netaddr/netaddr/blob/master/CHANGELOG.rst diff --git a/requirements.txt b/requirements.txt index 700d147b6..7a5439a99 100644 --- a/requirements.txt +++ b/requirements.txt @@ -24,7 +24,8 @@ Jinja2==3.1.6 jsonschema==4.25.0 Markdown==3.8.2 mkdocs-material==9.6.16 -mkdocstrings[python]==0.30.0 +mkdocstrings==0.30.0 +mkdocstrings-python==1.18.2 netaddr==1.3.0 nh3==0.3.0 Pillow==11.3.0 From 44dae992054ff3669152129f503af51a579be573 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 29 Aug 2025 13:56:12 -0400 Subject: [PATCH 2/3] Suppress griffe warnings for missing type annotations in docstrings --- mkdocs.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index a2cec0c0c..d8524e593 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -30,6 +30,8 @@ plugins: python: paths: ["netbox"] options: + docstring_options: + warn_missing_types: false heading_level: 3 members_order: source show_root_heading: true From 6e6c02f98c57f5f9c6c86eb644671ea8e3e8fb97 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 29 Aug 2025 13:59:55 -0400 Subject: [PATCH 3/3] Fix invalid link --- docs/plugins/development/models.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/plugins/development/models.md b/docs/plugins/development/models.md index 2582fd4bf..eb12204ff 100644 --- a/docs/plugins/development/models.md +++ b/docs/plugins/development/models.md @@ -24,7 +24,7 @@ Every model includes by default a numeric primary key. This value is generated a ## Enabling NetBox Features -Plugin models can leverage certain [model features](../development/models.md#features-matrix) (such as tags, custom fields, event rules, etc.) by inheriting from NetBox's `NetBoxModel` class. This class performs two crucial functions: +Plugin models can leverage certain [model features](../../development/models.md#features-matrix) (such as tags, custom fields, event rules, etc.) by inheriting from NetBox's `NetBoxModel` class. This class performs two crucial functions: 1. Apply any fields, methods, and/or attributes necessary to the operation of these features 2. Register the model with NetBox as utilizing these features