Skip to content

Update 'watch' option in mkdocs.yml #21

Open
@pheus

Description

@pheus

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions