Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add support for globs in paths configuration #33

Closed
AndrewGuenther opened this issue Aug 10, 2022 · 1 comment · Fixed by #34
Closed

Add support for globs in paths configuration #33

AndrewGuenther opened this issue Aug 10, 2022 · 1 comment · Fixed by #34

Comments

@AndrewGuenther
Copy link
Contributor

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.
AndrewGuenther added a commit to AndrewGuenther/mkdocstrings-python that referenced this issue Aug 10, 2022
@AndrewGuenther
feat: Add support for globs in paths configuration
749e48c 
This change allows for values in the paths configuration option to be
globs by resolving them before passing them off to griffe.

fixes mkdocstrings#33
@AndrewGuenther AndrewGuenther mentioned this issue Aug 10, 2022
Merged
@pawamoy
Copy link
Member

pawamoy commented Aug 17, 2022

Yup, good idea, valid use-case, easy addition.

pawamoy pushed a commit that referenced this issue Sep 23, 2022
@AndrewGuenther
feat: Add support for globs in paths configuration
29edd02 
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: Add support for globs in paths configuration AndrewGuenther/mkdocstrings-python
2 participants
@AndrewGuenther @pawamoy