DeprecationWarning for mkdocstrings #7075

Closed
opened 2025-12-29 20:18:56 +01:00 by adam · 0 comments
Owner

Originally created by @candlerb on GitHub (Oct 5, 2022).

Originally assigned to: @arthanson on GitHub.

NetBox version

v3.3.5

Python version

3.8

Steps to Reproduce

Upgrade from v3.3.4 to v3.3.5

Watch the output from ./upgrade.sh

Expected Behavior

Clean upgrade

Observed Behavior

Building documentation (mkdocs build)...
INFO     -  Cleaning site directory
INFO     -  Building documentation to directory: /opt/netbox/netbox/project-static/docs
INFO     -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
              - index.md
INFO     -  DeprecationWarning: 'selection' and 'rendering' are deprecated and merged into a single 'options' YAML key
              File "/opt/netbox/venv/lib/python3.8/site-packages/mkdocstrings/extension.py", line 121, in run
                html, handler, data = self._process_block(identifier, block, heading_level)
              File "/opt/netbox/venv/lib/python3.8/site-packages/mkdocstrings/extension.py", line 185, in _process_block
                warn(
INFO     -  Documentation built in 60.16 seconds

This doesn't actually cause any problems (yet), but implies there is some housekeeping required to update how mkdocstrings is being invoked. Possibly in mkdocs.yml at the top level.

Originally created by @candlerb on GitHub (Oct 5, 2022). Originally assigned to: @arthanson on GitHub. ### NetBox version v3.3.5 ### Python version 3.8 ### Steps to Reproduce Upgrade from v3.3.4 to v3.3.5 Watch the output from `./upgrade.sh` ### Expected Behavior Clean upgrade ### Observed Behavior ``` Building documentation (mkdocs build)... INFO - Cleaning site directory INFO - Building documentation to directory: /opt/netbox/netbox/project-static/docs INFO - The following pages exist in the docs directory, but are not included in the "nav" configuration: - index.md INFO - DeprecationWarning: 'selection' and 'rendering' are deprecated and merged into a single 'options' YAML key File "/opt/netbox/venv/lib/python3.8/site-packages/mkdocstrings/extension.py", line 121, in run html, handler, data = self._process_block(identifier, block, heading_level) File "/opt/netbox/venv/lib/python3.8/site-packages/mkdocstrings/extension.py", line 185, in _process_block warn( INFO - Documentation built in 60.16 seconds ``` This doesn't actually cause any problems (yet), but implies there is some housekeeping required to update how mkdocstrings is being invoked. Possibly in `mkdocs.yml` at the top level.
adam added the type: bugstatus: needs owner labels 2025-12-29 20:18:56 +01:00
adam closed this issue 2025-12-29 20:18:56 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#7075