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.

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

feat: Add support for globs in paths configuration #34

Merged
merged 2 commits into from Sep 23, 2022

Conversation

AndrewGuenther
Copy link
Contributor

@AndrewGuenther AndrewGuenther commented 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.

fixes #33

mkdocs.yml Outdated
Comment on lines 86 to 87
paths:
- src/*
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I only made this change as a test to ensure things are working as expected when running make docs-serve. I can remove it, but I wanted to include it initially to show how I tested.

Copy link
Member

@pawamoy pawamoy Aug 17, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, you can remove it now, thanks.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

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
Copy link
Contributor Author

These failures don't appear to be related to my change. I encountered these same failures when attempting to run tests on the main branch without my changes as well.

@pawamoy
Copy link
Member

pawamoy commented Aug 17, 2022

Oh, indeed, sorry about that. Let me fix these first.

@AndrewGuenther
Copy link
Contributor Author

@pawamoy Friendly ping to see if we can get this merged

@pawamoy pawamoy merged commit 29edd02 into mkdocstrings:master Sep 23, 2022
@pawamoy
Copy link
Member

pawamoy commented Sep 23, 2022

Thanks for the ping! LGTM, merging 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add support for globs in paths configuration
2 participants