starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Upgrade mkdocstrings to v0.28.0 #10730

New Issue
Closed
opened 2025-12-29 21:35:17 +01:00 by adam · 1 comment
adam commented 2025-12-29 21:35:17 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Feb 4, 2025).

Originally assigned to: @tobiasge on GitHub.

Proposed Changes

Upgrade mkdocstrings from v0.27.0 to v0.28.0.

Justification

mkdocstrings v0.28.0 fails when building the docs with the following error:

ERROR   -  mkdocstrings: module 'netbox' has no attribute 'jobs'
           Traceback (most recent call last):
             File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/pytkdocs/cli.py", line 214, in main
               output = json.dumps(process_json(line))
             File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/pytkdocs/cli.py", line 126, in process_json
               return process_config(json.loads(json_input))
             File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/pytkdocs/cli.py", line 104, in process_config
               obj = loader.get_object_documentation(path, members)
             File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/pytkdocs/loader.py", line 334, in get_object_documentation
               leaf = get_object_tree(dotted_path, self.new_path_syntax)
             File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/pytkdocs/loader.py", line 263, in get_object_tree
               obj = getattr(current_node.obj, obj_name)
           AttributeError: module 'netbox' has no attribute 'jobs'
ERROR   -  Error reading page 'plugins/development/background-jobs.md':
ERROR   -  Could not collect 'netbox.jobs.JobRunner'
Originally created by @jeremystretch on GitHub (Feb 4, 2025). Originally assigned to: @tobiasge on GitHub. ### Proposed Changes Upgrade `mkdocstrings` from v0.27.0 to v0.28.0. ### Justification `mkdocstrings` v0.28.0 fails when building the docs with the following error: ``` ERROR - mkdocstrings: module 'netbox' has no attribute 'jobs' Traceback (most recent call last): File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/pytkdocs/cli.py", line 214, in main output = json.dumps(process_json(line)) File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/pytkdocs/cli.py", line 126, in process_json return process_config(json.loads(json_input)) File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/pytkdocs/cli.py", line 104, in process_config obj = loader.get_object_documentation(path, members) File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/pytkdocs/loader.py", line 334, in get_object_documentation leaf = get_object_tree(dotted_path, self.new_path_syntax) File "/home/jstretch/projects/netbox/venv/lib/python3.10/site-packages/pytkdocs/loader.py", line 263, in get_object_tree obj = getattr(current_node.obj, obj_name) AttributeError: module 'netbox' has no attribute 'jobs' ERROR - Error reading page 'plugins/development/background-jobs.md': ERROR - Could not collect 'netbox.jobs.JobRunner' ```
adam added the status: acceptedtype: housekeeping labels 2025-12-29 21:35:17 +01:00
adam closed this issue 2025-12-29 21:35:18 +01:00
adam commented 2025-12-29 21:35:18 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Feb 11, 2025):

I've spent some time poking around at this but haven't been able to determine the cause for the failure. The current configuration has been in place for a long time and loads fine under mkdocstrings v0.27.0. I've tried setting the Python path via the paths option (which also works under v0.27.0) with no luck.

@jeremystretch commented on GitHub (Feb 11, 2025): I've spent some time poking around at this but haven't been able to determine the cause for the failure. The [current configuration ](https://github.com/netbox-community/netbox/blob/154b3a7abbbcb0d700257a250af82315644206cb/mkdocs.yml#L28) has been in place for a long time and loads fine under mkdocstrings v0.27.0. I've tried setting the Python path via the `paths` option (which also works under v0.27.0) with no luck.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label status: accepted type: housekeeping
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#10730
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?