Procházet zdrojové kódy

Merge pull request #20209 from netbox-community/20092-mkdocs-cleanup

Closes #20092: Clean up `mkdocs` warnings
bctiemann před 5 měsíci
rodič
revize
8f8ca805c4
4 změnil soubory, kde provedl 10 přidání a 3 odebrání
  1. 5 1
      base_requirements.txt
  2. 1 1
      docs/plugins/development/models.md
  3. 2 0
      mkdocs.yml
  4. 2 1
      requirements.txt

+ 5 - 1
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

+ 1 - 1
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

+ 2 - 0
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

+ 2 - 1
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