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

Set up docs #403

Merged
merged 10 commits into from
Nov 28, 2024
Merged

Set up docs #403

merged 10 commits into from
Nov 28, 2024

Conversation

albertvillanova
Copy link
Member

@albertvillanova albertvillanova commented Nov 25, 2024

Set up docs.

TODO:

@clefourrier clefourrier marked this pull request as ready for review November 27, 2024 14:34
@albertvillanova
Copy link
Member Author

@clefourrier I do not have write access permission.
Could you please merge this PR? We need the GH Action to upload the docs to be in the main branch for it to work (in the following PRs).

Reply by @regisss:

The doc is actually built but not uploaded. That happens because the doc upload workflow is not part of the main branch (yet).
So, if you merge PR #403, PR docs should be uploaded properly once they are built.

@albertvillanova
Copy link
Member Author

Alternatively, we could merge the GH Actions in a separate PR and check the resulting docs in this PR before merging it.
Thanks again @regisss for the advice.

Copy link
Member

@clefourrier clefourrier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@HuggingFaceDocBuilderDev
Copy link
Collaborator

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

@clefourrier
Copy link
Member

can we merge it? 👀 👀 👀 👀

@albertvillanova
Copy link
Member Author

albertvillanova commented Nov 28, 2024

Yes, but the PRs on the Hub backend need to be merged as well.

@albertvillanova albertvillanova merged commit 0c80801 into huggingface:main Nov 28, 2024
3 checks passed
@albertvillanova
Copy link
Member Author

Docs in production: https://huggingface.co/docs/lighteval/index
No link to them yet from: https://huggingface.co/docs

  • The PRs on the Hub backend need to be merged

@clefourrier
Copy link
Member

Haaaa 😞
Still quite good though!

@clefourrier
Copy link
Member

If you have a min (tmr ofc), it would be great to check how we can get the cool autodocs from the docstrings, I think there's a lib to run/add somewhere

@albertvillanova
Copy link
Member Author

Sure, @clefourrier! It was in my TODO list. Indeed, I was looking for these class/function docs when I started using lighteval and suggested to set up its docs.

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.

4 participants