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.

Sign up for GitHub

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

Jump to bottom

Update to slugify function of markdown_extensions (DeprecationWarning) #22

Open
pheus opened this issue Jul 28, 2024 · 0 comments · May be fixed by #26
Open

Update to slugify function of markdown_extensions (DeprecationWarning) #22

pheus opened this issue Jul 28, 2024 · 0 comments · May be fixed by #26

Comments

@pheus
Copy link

pheus commented Jul 28, 2024

cookiecutter-netbox-plugin version

main (d920039)

Python version

3.12

Steps to Reproduce

  1. Run cookiecutter https://github.com/netbox-community/cookiecutter-netbox-plugin.git
  2. Fill out the default values
  3. Run mkdocs serve -a localhost:8080

Expected Behavior

markdown_extensions:
[...]
  - toc:
      baselevel: 2
      permalink: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify {}

Observed Behavior

(Snippet from the generated mkdocs.yml with default values)

markdown_extensions:
[...]
  - toc:
      baselevel: 2
      permalink: true
      slugify: !!python/name:pymdownx.slugs.uslugify
INFO    -  DeprecationWarning: 'uslugify' is deprecated. 'uslugify' is deprecated in favor of the
           configurable 'slugify' function. See documentation for more info.
pheus added a commit to pheus/cookiecutter-netbox-plugin that referenced this issue Jul 28, 2024
@pheus
fix(mkdocs): Correct slugify function in mkdocs.yml
182d95e 
Update slugify configuration to use pymdownx's slugify method.
(DeprecationWarning: 'uslugify' is deprecated.)

Fixes netbox-community#22
@pheus pheus linked a pull request Jul 28, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix(mkdocs): Correct slugify function in mkdocs.yml pheus/cookiecutter-netbox-plugin
1 participant
@pheus