Skip to content

Add configuration for git path #31

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

Closed
wants to merge 2 commits into from
Closed

Conversation

marianafantini
Copy link

@marianafantini marianafantini commented May 5, 2020

We've added a config git_path that can be used to specify the folder that contains the git repository. If this configuration is not set, the default will be ., which was the previous behavior
We've added this because our git repository info is inside a docs folder, different from the mkdocs default structure, and that configuration would help for situations like that

Co-authored-by: William Seiti Mizuta <[email protected]>
@williammizuta
Copy link

We didn't understand why the test is failing on Windows. Can someone help us to understand what is broken?

@timvink
Copy link
Owner

timvink commented May 6, 2020

Hi @marianafantini and @williammizuta,

Thanks for the contribution! Much appreciated :)

Some comments:

  • The windows error is probably related to a change in the windows gitlab runner. I added a workaround hack in Extend unit tests to cover more python versions #32.
  • The use-case is valid, but I would prefer to keep the number of options as low as possible (and thus the plugin small & simple to use). Because we use git on files in the docs/ folder, it makes sense to start looking there for a .git folder and traverse upwards. I went ahead and implemented that in Custom git path #33, along with a matching unit test. I do realize that will make this PR redundant, sorry!

I'll release the changes to PyPI today, let me know if this fixes your use-case?

@timvink timvink closed this May 6, 2020
@williammizuta
Copy link

We have tested the new version and it worked for us. Thank you for the support

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.

3 participants