sphinx-contrib / video

A sphinx plugin that enables embedding of HTML5 videos
https://sphinxcontrib-video.readthedocs.io
Apache License 2.0
43 stars 29 forks source link

fix: make build parralel friendly #15

Closed 12rambau closed 1 year ago

12rambau commented 1 year ago

superceed #10

benjaoming commented 1 year ago

This didn't include the parts from #10 that skips adding videos to irrelevant formats? Was that on purpose?

        latex=ignore_node,
        text=ignore_node,
        man=ignore_node,
        texifo=ignore_node,
benjaoming commented 1 year ago

Ah, it's in #16 :+1:

12rambau commented 1 year ago

I'm going to use squash merges from now so I try to split things up

benjaoming commented 1 year ago

All good :+1:

Looking forwards to the release! I did this write-up while trying to figure out how on earth to quickly put instruction videos in documentation: https://github.com/benjaoming/anti-pattern-sphinx-video-downloader

Would be curious if you have considered various approaches and what you think is the best way forward for documentation projects in general?

Are you going to put the documentation up on RTD? :)

12rambau commented 1 year ago

TBH the youtube solution in combination with sphinxcontrib-youtube works quite well for huge videos. Note that github LFS is not supported in RDT (last time I checked). Note that Drive videos behave the same as a youtube video and ca thus be wired the same way.

On the other hand, for smaller one that you can afford to host in your docs (a 1 min demo of the product/tool) sphinxcontrib-video should do the trick.

benjaoming commented 1 year ago

Git LFS is supported on RTD by extending the build process: https://docs.readthedocs.io/en/stable/build-customization.html#support-git-lfs-large-file-storage

12rambau commented 1 year ago

that's perfect, it seems I'm confusing with another service ;-)

benjaoming commented 1 year ago

I'm not so clear in the description on https://github.com/benjaoming/anti-pattern-sphinx-video-downloader, but I suggest basically to have 2 repos active for documentation with video:

1) Repo for the documentation: Because it's documentation, it changes often and is built often, so we don't want large files here. During builds, we download videos from repo 2 (and can store them in a local cache if possible).

2) Repo/resource for videos: Here, we store and publish the videos. This can be both Git and Google Drive, depending on what level of archive history that you need.

Note: The name of the video could be versioned such that old documentation can keep the original videos that they were published with.