-
Notifications
You must be signed in to change notification settings - Fork 350
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
Use dvc to manage docs images #6267
Conversation
@seisman, the vercel deployment fails on the
Since you have more experience with the vercel setup, do you know of any reason to avoid venv and bootstrapping a user pip install for this case? |
The raw error message is:
Perhaps this solution (sloria/TextBlob#173 (comment)) works? |
Thanks @seisman, the vercel docs are working now with dvc. |
I added |
Description of proposed changes
Originally we discussed only using dvc to track the test images, in part because there are fewer docs images and theoretically they change less often. However, there are already several outdated docs images with more likely due to remote dataset updates. This PR configures the docs and tests workflows to use dvc rather than git to manage the baseline images in doc/examples and doc/scripts to allow for these to be updated without bloating the git history.
One current limitation is that the CMake settings do not include the new
doc/examples/images
anddoc/scripts/images
directories in the release tarballs, meaning that people can not build the html docs from the tarballs. But, this relates to #2681 in that we also includedocs_release
in the release tarballs which contains optimized versions of those images. So do we need both? Or could we set a CMake target to generate the .PS files from the scripts as a compromise that would allow some users to build the html docs from source while shrinking the release tarball size for everyone?Part of #5724