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

fix: search parent directories to find repository #47

Merged
merged 1 commit into from
Jan 7, 2024

Conversation

thor
Copy link
Contributor

@thor thor commented Dec 24, 2023

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.

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.
@thor thor changed the title fix: search parent directories for the repo fix: search parent directories to find repository Dec 24, 2023
@ojacques
Copy link
Owner

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

@thor
Copy link
Contributor Author

thor commented Dec 28, 2023

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

lord-vesel commented Dec 29, 2023

It must be configurable and defaults to false

Like this: #48

@thor
Copy link
Contributor Author

thor commented Jan 5, 2024

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
Copy link
Owner

ojacques commented Jan 7, 2024

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.

@ojacques ojacques merged commit 0936ad9 into ojacques:master Jan 7, 2024
@ojacques ojacques mentioned this pull request Jan 7, 2024
@thor thor deleted the patch-1 branch January 7, 2024 12:55
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.

Default to using Repo(".") rather than checking parent dir for subdirs
3 participants