search

scality / runner-manager

Service to manage github Actions self-hosted runners
https://scality.github.io/runner-manager/
Apache License 2.0
7 stars 7 forks source link

fix(docs): deprecation warning in mkdocs #572

Closed lewismiddleton closed 3 months ago

lewismiddleton commented 3 months ago

Address deprecation warning when running poetry run mkdocs build --strict.

From the upstream mkdocs-material emoji documentation:

  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
lewismiddleton commented 3 months ago

Previously was outputting deprecation warnings in the logs:

INFO    -  DeprecationWarning: 'materialx.emoji.twemoji' is deprecated.
           Material emoji logic has been officially moved into mkdocs-material
           version 9.4. Please use Material's 'material.extensions.emoji.twemoji'
           as mkdocs_material_extensions is deprecated and will no longer be
           supported moving forward. This is the last release.

             File "/workspaces/runner-manager/.venv/lib/python3.11/site-packages/materialx/emoji.py", line 106, in twemoji
               return _patch_index(options)
             File "/workspaces/runner-manager/.venv/lib/python3.11/site-packages/materialx/emoji.py", line 59, in _deprecated_func
               warnings.warn(
WARNING -  Material emoji logic has been officially moved into mkdocs-material
           version 9.4. Please use Material's 'material.extensions.emoji.twemoji'
           as mkdocs_material_extensions is deprecated and will no longer be
           supported moving forward. This is the last release.
INFO    -  Cleaning site directory
INFO    -  Building documentation to directory: /workspaces/runner-manager/site
INFO    -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
             - development/backends.md
INFO    -  Documentation built in 0.84 seconds