Cannot establish repo name from Git remote

First off, I want to thank you for this very interesting project!

I was trying to use portray for my project, and found that it broke when I tried to run

portray in_browser

It said

UserWarning: Unable to identify `repo_name` and `repo_url` automatically

I looked through the code and found that this was issued because portray could not determine the name of my project from the git remote. I seldom use http for cloning, preferring ssh myself and since I also use Azure Devops during working hours I have remotes looking like

[e-mail]:v3/username/projectname/reponame

This origin-remote will be ignored by the if-clause in config.py#L141.

[timothycrosley]

I’ve included repo discovery improvements and additional documentation in the just released 1.3.0 version of portray.

I’ve added a guide on how to deal with the warning and what it means in the updated troubleshooting guide

@hbldh It turns out I’m able to often determine the http link from a the ssh URL making it useful. User configs will indeed take precedence over any auto determinations.

@sindrehan Happy to help! Agreed! I’ve made this change in the lastest release, empowering users to remove this warning.

Thanks!

~Timothy

[sindrehan]

@timothycrosley Ah, I see, thanks! I just did a quick grep over the repo for repo_url and repo_name and could only find references to where the values are set, but since they’re passed to mkdocs that makes sense.

Also, I think it would make sense to not raise a warning if the user has specified the url/name manually.