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

[API Reference docs] Lack of images #812

Open
LysandreJik opened this issue Mar 31, 2022 · 3 comments
Open

[API Reference docs] Lack of images #812

LysandreJik opened this issue Mar 31, 2022 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@LysandreJik
Copy link
Member

Some images are not rendered correclty in the documentation, and a process needs to be set regarding the contribution of assets to the repository.

@LysandreJik LysandreJik self-assigned this Mar 31, 2022
@adrinjalali adrinjalali added the documentation Improvements or additions to documentation label Mar 31, 2022
@adrinjalali
Copy link
Contributor

I've seen discussions where people say images should be loaded from somewhere else. I kinda think people should be able to build and view the docs w/o any network access, and that the images should be included or built by the doc build process.

If the images are produced by code, they can be build by the doc builder, and form user guide we can refer to those images, like you do with sphinx-gallery example files.

@LysandreJik
Copy link
Member Author

Agree with you that building and viewing the docs offline would be ideal. Right now the images are hosted somewhere else than in the documentation, for example here: https://huggingface.co/datasets/huggingface/documentation-images/tree/main

The reason why it's not the case right now:

  • Images can end up weighing a significant amount and cannot be removed from the git history once merged into main, resulting in an unnecessarily long git clone
  • I understand there may be issues related to serving objects coming from repositories (cc @mishig25 @Pierrci)

@adrinjalali
Copy link
Contributor

It'll be the website repo which gets large, not a repo which is cloned by people, so clone time shouldn't be an issue, and in CI we can shallow clone which fixes the size issue.

Once in a while, if the website repo gets too large, we can collapse its history, since it's not important (ref: scikit-learn/scikit-learn#21171)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants