cookiecutter-pypackage icon indicating copy to clipboard operation
cookiecutter-pypackage copied to clipboard

mkdocs serve error

Open will-wright-eng opened this issue 2 years ago • 0 comments

  • Date you used Cookiecutter PyPackage: 2022-07-14
  • Cookiecutter version used, if any:
  • Python version, if any:
  • Operating System: macos

Description

Followed Tutorial

What I Did

poetry run mkdocs serve

FileNotFoundError: [Errno 2] No such file or directory:

The fix is to change the watched directory within mkdocs.yml from project_slug to pkg_name: https://github.com/waynerv/cookiecutter-pypackage/blob/f94e6534590f49b079f91aef31666faa217a53e6/%7B%7Bcookiecutter.project_slug%7D%7D/mkdocs.yml#L54

plugins:
  - include-markdown
  - search:
      lang: en
  - mkdocstrings:
      watch:
        - {{ cookiecutter.pkg_name }}

will-wright-eng avatar Jul 14 '22 08:07 will-wright-eng