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 'watch' option in mkdocs.yml #21

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

Update 'watch' option in mkdocs.yml #21

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

Comments

@pheus
Copy link

pheus commented Jul 28, 2024 •
edited
Loading

cookiecutter-netbox-plugin version

main (d920039)

Python version

3.12

Steps to Reproduce

The generated mkdocs.yml file contains the watch configuration for mkdocstrings, which is no longer supported.

  1. Run cookiecutter https://github.com/netbox-community/cookiecutter-netbox-plugin.git
  2. Fill out the default values
  3. Check generated mkdocs.yml

Expected Behavior

The watch configuration is supported by mkdocs.

plugins:
  - include-markdown
  - search:
      lang: en
watch:
  - netbox_acl_plugin

Observed Behavior

The generated mkdocs.yml file contains the following configuration:

plugins:
  - include-markdown
  - search:
      lang: en
  - mkdocstrings:
      watch:
        - netbox-acl-plugin

Running mkdocs v1.6.0 with mkdocsstrings v0.25.2 does throw a warning:

WARNING -  Config value 'plugins': Plugin 'mkdocstrings' option 'watch': Unrecognised configuration
           name: watch
pheus added a commit to pheus/cookiecutter-netbox-plugin that referenced this issue Jul 28, 2024
@pheus
fix(mkdocs): Correct watch path config in mkdocs
dc2b284 
This commit fixes the configuration of the watch path in mkdocs. The
'watch' configuration previously supported by mkdocstrings is now
integrated into mkdocs. The directory referencing has been fixed by
using underscores instead of hyphens. This change will ensure the
compatibility of mkdocs with the mkdocstrings plugin.

Fixes netbox-community#21
@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 watch path config in mkdocs pheus/cookiecutter-netbox-plugin
1 participant
@pheus