search

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

adding some video block attributes #29

Open Borda opened 1 year ago

Borda commented 1 year ago

Would it be possible to add some extra attributes to the video block, for example, we are using:

<video 
    width="50%"
    max-width="400px"
    controls
    poster="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/pl_docs/trainer_flags/thumb/check_val_every_n_epoch.jpg"
    src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/pl_docs/trainer_flags/check_val_every_n_epoch.mp4"
></video>

as this is not obvious from the readme and it would help us with https://github.com/Lightning-AI/lightning/pull/17941#issuecomment-1611280429

Borda commented 1 year ago

UPDATE: it seems most of them are there: https://github.com/sphinx-contrib/video/blob/0c5d54cf5b16584dee4a3649246674c9288707cc/sphinxcontrib/video.py#L28 so maybe just update the readme with a rich example?