Skip to content

Projects: Trying to follow basic setup and failing #6360

@danielloader

Description

@danielloader

Context

  • Python 3.11.6
  • MacOS 14.1
  • Mkdocs 1.5.1

Bug description

I've tried to follow the project plugin documentation to set up a basic example, with a single example project inside the projects directory.

However doing the bare minimum to try and get this working has ended in failure for me.

Related links

Reproduction

9.4.9+insiders.4.43.0-projects-missing-directory.zip

Steps to reproduce

  1. Create initial parent mkdocs project using mkdocs new .
  2. Configure resulting mkdocs.yml file with theme being set to material, projects plugin enabled.
  3. Create projects directory in the root of the project.
  4. Execute mkdocs new abc in the projects directory.
  5. Add relevant navigation to link the two using the project:// url scheme.
    nav:
      - Home: index.md
      - abc: project://abc
  6. Try and run mkdocs serve.
  7. Get the resulting error:
    > mkdocs serve
    INFO    -  Building documentation...
    INFO    -  Cleaning site directory
    ERROR   -  Couldn't find project '.abc'
    
    Aborted with a BuildError!

Browser

No response

Before submitting

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions