backstage / backstage/mkdocs-monorepo-plugin
DeprecationWarning Related to warning_filter in the mkdocs-monorepo-plugin
- Dominant language
- Python
- Stars
- 400
- Forks
- 80
- PR merge metrics
- No merged PRs in 30d
Description
Hello, development team,
I am using the mkdocs-monorepo-plugin in my project, and I recently encountered a deprecation warning that I would like to report. When running the build, the following warning is displayed:
```
INFO - DeprecationWarning: warning_filter doesn't do anything since MkDocs 1.2 and will be removed soon. All messages on the `mkdocs` logger get counted automatically.
File "/home/miquelis/.local/share/virtualenvs/infra-docs-hDAreFVa/lib/python3.11/site-packages/mkdocs_monorepo_plugin/parser.py", line 22, in
from mkdocs.utils import yaml_load, warning_filter, dirname_to_title, get_markdown_title
File "/home/miquelis/.local/share/virtualenvs/infra-docs-hDAreFVa/lib/python3.11/site-packages/mkdocs/utils/__init__.py", line 403, in __getattr__
warnings.warn
```
It seems that the `warning_filter` function has been deprecated since MkDocs 1.2 and will be removed in future versions. To ensure future compatibility of the plugin and avoid potential issues, I suggest that this function be removed or replaced with a compatible alternative.
I appreciate the great work on this plugin, and I am available for any further assistance or testing that might be needed.
Thank you for your attention!
Contributor guide
Research direction
Start in parser.py at the import on line 22 and run the reported MkDocs build to reproduce the warning. Check the current MkDocs compatibility guidance for warning_filter and verify the build completes without this deprecation warning while preserving the plugin's documentation behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100