Skip to content

Add support for globs in paths configuration #33

Description

@AndrewGuenther

Is your feature request related to a problem? Please describe.
We are using mkdocs in a monorepo. In this monorepo, we have many packages and a top level mkdocs configuration. We currently need to list every one of our package paths individually in the paths configuration option. However, the paths to all the modules in our monorepo could be easily described with a couple globs (ex: lib/*/module).

Describe the solution you'd like
It would be great if the paths configuration option supported a glob syntax.

Describe alternatives you've considered
We've thought about making our mkdocs.yml a generated file, but this is a bit cumbersome.

Additional context
I could see this being done either in this package by resolving the globs before passing them to the griffe loader or as a native feature of griffe itself. Based on the code though, it seems like it would be simplest to add directly in this package.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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