-
Notifications
You must be signed in to change notification settings - Fork 35
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
Add repo owner to doc source links #334
Conversation
@mishig25 do you think I should go with:
|
@sgugger mind having a look at this and weighing in on the above? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for working on this. I think it's better to parametrize everything, just in case we end up re-using the doc-builder for other repos outside of huggingface, like bigscience (and since you have done most of the work already ;-) )
Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com>
@sgugger, I think we're good to go here 🤞 I made updates to reflect your review comments (thanks so much!!) I'll need to remove hard coded references to this PR's branch in the GitHub actions before we merge, though... needed to add that so I could work on huggingface/pytorch-image-models#1575. |
@nateraw, if I go to this preview page & click on one of the source links, for example: it should not have, string if it does not have |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, once @mishig25 's bug is fixed of course :-)
@mishig25 nice catch! I added the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm !
While adding some reference docs to
timm
's Docs, I noticed the "Source" links were incorrect in the API documentation - they always pointed github.com/huggingface/timm
. We want them to point github.com/rwightman/pytorch-image-models
.This PR aims to make that happen.
As of the time of creating this PR, there is an ambiguity between
package
andpackage_name
, which still makes links generate incorrectly withpackage_name=timm
, as the github repo name should still bepytorch-image-models
. Will sort out a fix for that...