mirror of
https://github.com/netbox-community/netbox.git
synced 2025-09-06 14:23:36 -06:00
Merge pull request #20209 from netbox-community/20092-mkdocs-cleanup
Some checks failed
CI / build (20.x, 3.10) (push) Has been cancelled
CI / build (20.x, 3.11) (push) Has been cancelled
CI / build (20.x, 3.12) (push) Has been cancelled
CodeQL / Analyze (${{ matrix.language }}) (none, actions) (push) Has been cancelled
CodeQL / Analyze (${{ matrix.language }}) (none, javascript-typescript) (push) Has been cancelled
CodeQL / Analyze (${{ matrix.language }}) (none, python) (push) Has been cancelled
Some checks failed
CI / build (20.x, 3.10) (push) Has been cancelled
CI / build (20.x, 3.11) (push) Has been cancelled
CI / build (20.x, 3.12) (push) Has been cancelled
CodeQL / Analyze (${{ matrix.language }}) (none, actions) (push) Has been cancelled
CodeQL / Analyze (${{ matrix.language }}) (none, javascript-typescript) (push) Has been cancelled
CodeQL / Analyze (${{ matrix.language }}) (none, python) (push) Has been cancelled
Closes #20092: Clean up `mkdocs` warnings
This commit is contained in:
commit
8f8ca805c4
@ -106,7 +106,11 @@ mkdocs-material
|
|||||||
|
|
||||||
# Introspection for embedded code
|
# Introspection for embedded code
|
||||||
# https://github.com/mkdocstrings/mkdocstrings/blob/main/CHANGELOG.md
|
# 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
|
# Library for manipulating IP prefixes and addresses
|
||||||
# https://github.com/netaddr/netaddr/blob/master/CHANGELOG.rst
|
# https://github.com/netaddr/netaddr/blob/master/CHANGELOG.rst
|
||||||
|
@ -24,7 +24,7 @@ Every model includes by default a numeric primary key. This value is generated a
|
|||||||
|
|
||||||
## Enabling NetBox Features
|
## 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
|
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. Register the model with NetBox as utilizing these features
|
||||||
|
@ -30,6 +30,8 @@ plugins:
|
|||||||
python:
|
python:
|
||||||
paths: ["netbox"]
|
paths: ["netbox"]
|
||||||
options:
|
options:
|
||||||
|
docstring_options:
|
||||||
|
warn_missing_types: false
|
||||||
heading_level: 3
|
heading_level: 3
|
||||||
members_order: source
|
members_order: source
|
||||||
show_root_heading: true
|
show_root_heading: true
|
||||||
|
@ -24,7 +24,8 @@ Jinja2==3.1.6
|
|||||||
jsonschema==4.25.0
|
jsonschema==4.25.0
|
||||||
Markdown==3.8.2
|
Markdown==3.8.2
|
||||||
mkdocs-material==9.6.16
|
mkdocs-material==9.6.16
|
||||||
mkdocstrings[python]==0.30.0
|
mkdocstrings==0.30.0
|
||||||
|
mkdocstrings-python==1.18.2
|
||||||
netaddr==1.3.0
|
netaddr==1.3.0
|
||||||
nh3==0.3.0
|
nh3==0.3.0
|
||||||
Pillow==11.3.0
|
Pillow==11.3.0
|
||||||
|
Loading…
Reference in New Issue
Block a user