You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
AndrewGuenther
added a commit
to AndrewGuenther/mkdocstrings-python
that referenced
this issue
Aug 10, 2022
This change allows for values in the paths configuration option to be
globs by resolving them before passing them off to Griffe.
Issue #33: #33
PR #34: #34
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 ofgriffe
itself. Based on the code though, it seems like it would be simplest to add directly in this package.The text was updated successfully, but these errors were encountered: