Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove deprecation warning #131

Merged
merged 10 commits into from
Jan 19, 2024
Merged

Conversation

Spacetown
Copy link
Contributor

Remove the deprecation warnings:

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 "xxx/.venv/lib/python3.9/site-packages/mkdocs_multirepo_plugin/util.py", line 10, in <module>
               from mkdocs.utils import warning_filter
             File "xxx/.venv/lib/python3.9/site-packages/mkdocs/utils/__init__.py", line 453, in __getattr__
               warnings.warn(
INFO    -  Building documentation...
INFO    -  Multirepo plugin importing docs...
✅ xxx
INFO    -  Cleaning site directory
INFO    -  DeprecationWarning: _filter_paths is not used since MkDocs 1.5 and will be removed soon.
             File "xxx/.venv/lib/python3.9/site-packages/mkdocs_multirepo_plugin/structure.py", line 444, in get_files
               if _filter_paths(basename=dirname, path=path, is_dir=True, exclude=exclude):
             File "xxx/.venv/lib/python3.9/site-packages/mkdocs/structure/files.py", line 394, in _filter_paths
               warnings.warn(

Removing the function _filter_paths will also add support to include files in dot folders, dot files and the template folder.
To generate the documentation in ADO project we need to reference the pipeline in the folder .azuredevops and if you're documenting helm charts you have a folder templates.

Michael Foerderer (F29233) added 2 commits November 23, 2023 14:35
According to the logs this function is deprecated and also filtering of
files can have an impact to some projects. By default it's not possible
to add dot directories, dot files or the folder templates to the
documentation.

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 "xxx/.venv/lib/python3.9/site-packages/mkdocs_multirepo_plugin/util.py", line 10, in <module>
               from mkdocs.utils import warning_filter
             File "xxx/.venv/lib/python3.9/site-packages/mkdocs/utils/__init__.py", line 453, in __getattr__
               warnings.warn(
According to the logs this function is deprecated (a NOP).
Copy link

github-actions bot commented Nov 23, 2023

Version Number Check

Version has been updated in pyproject.toml.

@jdoiro3 jdoiro3 self-requested a review January 10, 2024 15:48
Copy link
Owner

@jdoiro3 jdoiro3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First off, thanks for contributing and using the plugin. I left a few suggestions/comments for you to address. I'm trying to get better at the version bumps and suggest we change the version to 0.7.0 since the other change part of this release isn't just a bugfix and changes behavior. Let me know if you don't agree.

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
mkdocs_multirepo_plugin/util.py Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
Spacetown and others added 3 commits January 10, 2024 21:48
Co-authored-by: Joseph Doiron <[email protected]>
Co-authored-by: Joseph Doiron <[email protected]>
Co-authored-by: Joseph Doiron <[email protected]>
@jdoiro3 jdoiro3 self-requested a review January 19, 2024 13:24
CHANGELOG.md Outdated Show resolved Hide resolved
Co-authored-by: Joseph Doiron <[email protected]>
CHANGELOG.md Outdated Show resolved Hide resolved
@jdoiro3 jdoiro3 merged commit 3ce1085 into jdoiro3:main Jan 19, 2024
14 checks passed
@Spacetown Spacetown deleted the remove_deprecation_warning branch January 19, 2024 14:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants