diff --git a/docs/administration/authentication/overview.md b/docs/administration/authentication/overview.md index e582f009e..19c86a4c0 100644 --- a/docs/administration/authentication/overview.md +++ b/docs/administration/authentication/overview.md @@ -54,6 +54,7 @@ Icons](https://github.com/google/material-design-icons) icon's name; or be `None` for no icon. For instance, the OIDC backend may be customized with + ```python SOCIAL_AUTH_BACKEND_ATTRS = { 'oidc': ("My awesome SSO", "login"), diff --git a/docs/customization/export-templates.md b/docs/customization/export-templates.md index 640a97531..4fc2fabf2 100644 --- a/docs/customization/export-templates.md +++ b/docs/customization/export-templates.md @@ -25,6 +25,7 @@ Height: {{ rack.u_height }}U To access custom fields of an object within a template, use the `cf` attribute. For example, `{{ obj.cf.color }}` will return the value (if any) for a custom field named `color` on `obj`. If you need to use the config context data in an export template, you'll should use the function `get_config_context` to get all the config context data. For example: + ``` {% for server in queryset %} {% set data = server.get_config_context() %} diff --git a/docs/integrations/graphql-api.md b/docs/integrations/graphql-api.md index c02045f34..87d9d8c49 100644 --- a/docs/integrations/graphql-api.md +++ b/docs/integrations/graphql-api.md @@ -60,6 +60,7 @@ query { } } ``` + In addition, filtering can be done on list of related objects as shown in the following query: ``` @@ -98,8 +99,8 @@ Certain queries can return multiple types of objects, for example cable terminat } } } - ``` + The field "class_type" is an easy way to distinguish what type of object it is when viewing the returned data, or when filtering. It contains the class name, for example "CircuitTermination" or "ConsoleServerPort". ## Authentication diff --git a/docs/plugins/development/index.md b/docs/plugins/development/index.md index 246816349..9dbf23e84 100644 --- a/docs/plugins/development/index.md +++ b/docs/plugins/development/index.md @@ -204,6 +204,7 @@ To ease development, it is recommended to go ahead and install the plugin at thi ```no-highlight $ pip install -e . ``` + More information on editable builds can be found at [Editable installs for pyproject.toml ](https://peps.python.org/pep-0660/). ## Configure NetBox diff --git a/docs/release-notes/version-2.1.md b/docs/release-notes/version-2.1.md index 7ec172b1f..0f84c80d9 100644 --- a/docs/release-notes/version-2.1.md +++ b/docs/release-notes/version-2.1.md @@ -150,5 +150,5 @@ The [NAPALM automation](https://github.com/napalm-automation/napalm) library pro * Modified the interface serializer to include three discrete fields relating to connections: `is_connected` (boolean), `interface_connection`, and `circuit_termination` * Added two new fields to the inventory item serializer: `asset_tag` and `description` * Added "wireless" to interface type filter (in addition to physical, virtual, and LAG) -* Added a new endpoint at /api/ipam/prefixes//available-ips/ to retrieve or create available IPs within a prefix +* Added a new endpoint at /api/ipam/prefixes//available-ips/ to retrieve or create available IPs within a prefix * Extended `parent_device` on DeviceSerializer to include the `url` and `display_name` of the parent Device, and the `url` of the DeviceBay diff --git a/mkdocs.yml b/mkdocs.yml index 193d10700..75020d122 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -28,12 +28,7 @@ plugins: - mkdocstrings: handlers: python: - setup_commands: - - import os - - import django - - os.chdir('netbox/') - - os.environ.setdefault("DJANGO_SETTINGS_MODULE", "netbox.settings") - - django.setup() + paths: ["netbox"] options: heading_level: 3 members_order: source diff --git a/requirements.txt b/requirements.txt index 4a9ac2aa0..19715f23a 100644 --- a/requirements.txt +++ b/requirements.txt @@ -21,7 +21,7 @@ gunicorn==23.0.0 Jinja2==3.1.6 Markdown==3.7 mkdocs-material==9.6.7 -mkdocstrings[python-legacy]==0.27.0 +mkdocstrings[python]==0.28.2 netaddr==1.3.0 nh3==0.2.21 Pillow==11.1.0