Upgrading from v3.3.5 to a newer version results in error with mkdocs #11014

Closed
opened 2025-12-29 21:39:10 +01:00 by adam · 1 comment
Owner

Originally created by @brwnie on GitHub (Apr 11, 2025).

Deployment Type

Self-hosted

NetBox Version

v3.3.5

Python Version

3.10

Steps to Reproduce

Following instructions on:
https://netboxlabs.com/docs/netbox/en/stable/installation/upgrading/

sudo git checkout v3.5.9
sudo NETBOX_DELETE_LEGACY_DATA=1 ./upgrade.sh

Same issue occurs on v3.7

Expected Behavior

Upgrade to complete to successfully complete

Observed Behavior

Traceback (most recent call last): File "/opt/netbox/venv/bin/mkdocs", line 8, in <module> sys.exit(cli()) File "/opt/netbox/venv/lib/python3.10/site-packages/click/core.py", line 1161, in __call__ return self.main(*args, **kwargs) File "/opt/netbox/venv/lib/python3.10/site-packages/click/core.py", line 1082, in main rv = self.invoke(ctx) File "/opt/netbox/venv/lib/python3.10/site-packages/click/core.py", line 1697, in invoke return _process_result(sub_ctx.command.invoke(sub_ctx)) File "/opt/netbox/venv/lib/python3.10/site-packages/click/core.py", line 1443, in invoke return ctx.invoke(self.callback, **ctx.params) File "/opt/netbox/venv/lib/python3.10/site-packages/click/core.py", line 788, in invoke return __callback(*args, **kwargs) File "/opt/netbox/venv/lib/python3.10/site-packages/mkdocs/__main__.py", line 288, in build_command build.build(cfg, dirty=not clean) File "/opt/netbox/venv/lib/python3.10/site-packages/mkdocs/commands/build.py", line 265, in build config = config.plugins.on_config(config) File "/opt/netbox/venv/lib/python3.10/site-packages/mkdocs/plugins.py", line 587, in on_config return self.run_event('config', config) File "/opt/netbox/venv/lib/python3.10/site-packages/mkdocs/plugins.py", line 566, in run_event result = method(item, **kwargs) File "/opt/netbox/venv/lib/python3.10/site-packages/mkdocs_autorefs/_internal/plugin.py", line 180, in on_config if self.config.link_titles == "auto": AttributeError: 'dict' object has no attribute 'link_titles'

Originally created by @brwnie on GitHub (Apr 11, 2025). ### Deployment Type Self-hosted ### NetBox Version v3.3.5 ### Python Version 3.10 ### Steps to Reproduce Following instructions on: https://netboxlabs.com/docs/netbox/en/stable/installation/upgrading/ ``` sudo git checkout v3.5.9 sudo NETBOX_DELETE_LEGACY_DATA=1 ./upgrade.sh ``` Same issue occurs on v3.7 ### Expected Behavior Upgrade to complete to successfully complete ### Observed Behavior `Traceback (most recent call last): File "/opt/netbox/venv/bin/mkdocs", line 8, in <module> sys.exit(cli()) File "/opt/netbox/venv/lib/python3.10/site-packages/click/core.py", line 1161, in __call__ return self.main(*args, **kwargs) File "/opt/netbox/venv/lib/python3.10/site-packages/click/core.py", line 1082, in main rv = self.invoke(ctx) File "/opt/netbox/venv/lib/python3.10/site-packages/click/core.py", line 1697, in invoke return _process_result(sub_ctx.command.invoke(sub_ctx)) File "/opt/netbox/venv/lib/python3.10/site-packages/click/core.py", line 1443, in invoke return ctx.invoke(self.callback, **ctx.params) File "/opt/netbox/venv/lib/python3.10/site-packages/click/core.py", line 788, in invoke return __callback(*args, **kwargs) File "/opt/netbox/venv/lib/python3.10/site-packages/mkdocs/__main__.py", line 288, in build_command build.build(cfg, dirty=not clean) File "/opt/netbox/venv/lib/python3.10/site-packages/mkdocs/commands/build.py", line 265, in build config = config.plugins.on_config(config) File "/opt/netbox/venv/lib/python3.10/site-packages/mkdocs/plugins.py", line 587, in on_config return self.run_event('config', config) File "/opt/netbox/venv/lib/python3.10/site-packages/mkdocs/plugins.py", line 566, in run_event result = method(item, **kwargs) File "/opt/netbox/venv/lib/python3.10/site-packages/mkdocs_autorefs/_internal/plugin.py", line 180, in on_config if self.config.link_titles == "auto": AttributeError: 'dict' object has no attribute 'link_titles'`
adam added the type: bug label 2025-12-29 21:39:10 +01:00
adam closed this issue 2025-12-29 21:39:10 +01:00
Author
Owner

@brwnie commented on GitHub (Apr 11, 2025):

I worked around this by commenting out in upgrade.sh:

# Build the local documentation
COMMAND="mkdocs build"
echo "Building documentation ($COMMAND)..."
eval $COMMAND || exit 1

then I successfully upgraded to v3.7.8

I removed the comment it for the upgrade to v4.2.7, it worked fine going from v3.7.8 to v4.2.7

So something wrong with mkdocs when going up to v3.7.8 it seems

@brwnie commented on GitHub (Apr 11, 2025): I worked around this by commenting out in upgrade.sh: ``` # Build the local documentation COMMAND="mkdocs build" echo "Building documentation ($COMMAND)..." eval $COMMAND || exit 1 ``` then I successfully upgraded to v3.7.8 I removed the comment it for the upgrade to v4.2.7, it worked fine going from v3.7.8 to v4.2.7 So something wrong with mkdocs when going up to v3.7.8 it seems
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#11014