search

ojacques / mkdocs-git-committers-plugin-2

MkDocs plugin for displaying a list of GitHub (.com or Enterprise) contributors on each page. Encourages contributions to the documentation!
MIT License
61 stars 21 forks source link

fix: search parent directories to find repository #47

Closed thor closed 10 months ago

thor commented 10 months ago

Fixes #41.

Allows for repositories where their documentation pipeline is not run from the root directory, e.g. a documentation repository where mkdocs.yml is at docs/mkdocs.yml, along with e.g. docs/pyproject.toml.

Particularly relevant for non-Python projects and monorepos.

ojacques commented 10 months ago

Thanks! I will merge this when I get back in front of a keyboard.

thor commented 10 months ago

Thanks! I will merge this when I get back in front of a keyboard.

Thanks for the prompt reply! Looking forward to it; if you may, let me know if it'll take a bit longer or if I may be of help.

lord-vesel commented 10 months ago

It must be configurable and defaults to false

Like this: #48

thor commented 10 months ago

It must be configurable and defaults to false

Like this: #48

Could you explain why, @lord-vesel?

Not that I personally mind, and it's not my call as I'm not a maintainer here, but I believe fewer configuration options are better unless there's a solid use-case and associated problem to explain why it is needed.

Especially the default: which scenario does this break?

ojacques commented 10 months ago

Looks good to me, at least as first step. I will comment on @lord-vesel 's PR and find out the use case. Thanks both.