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

Video support #7404

Open
petsuter opened this issue Mar 31, 2020 · 2 comments
Open

Video support #7404

petsuter opened this issue Mar 31, 2020 · 2 comments
Labels
markup type:enhancement enhance or introduce a new feature

Comments

@petsuter
Copy link
Contributor

In Sphinx images can be included with .. image:: or .. figure::.
But there is no support for videos yet, right?

It would be nice to have a .. video:: or even support videos in .. figure::.

A workaround is to use:

.. raw:: html

   <video controls src="video.mp4"></video>

This works quite well! ✨

But:

  • The workaround has none of the .. figure:: features, like a legend etc.
  • The workaround is too complicated for non-HTML-experts.
  • The workaround is too complicated if repeated for many videos.
  • The workaround will never work for non-HTML output formats.
  • Sphinx does not know to copy the video file.
  • ...

In the past video support was probably completely out-of-scope, but maybe nowadays it is easy and appropriate to support it?

Thanks for your consideration.

@petsuter petsuter added the type:enhancement enhance or introduce a new feature label Mar 31, 2020
@tk0miya tk0miya added the markup label Apr 4, 2020
@tk0miya
Copy link
Member

tk0miya commented Apr 4, 2020

+1: Nowadays, video is an important medium. It's reasonable to support.
-0: The only HTML supports it. Other formats do not.
-0: It would be better to add it to the original docutils spec. So it should be proposed into docutils project.

@tk0miya tk0miya added this to the some future version milestone Apr 4, 2020
@astrojuanlu
Copy link
Contributor

@gmilde notes in sphinx-dev:

I suppose the issue "Video support #7404" may be closed with a link to
https://docutils.sourceforge.io/HISTORY.html#release-0-17-2021-04-03

docutils/writers/html5_polyglot/init.py

[...]

Use

(Unless Sphinx patches the image/figure directive handling in a way that
breaks Docutils support for moving images.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
markup type:enhancement enhance or introduce a new feature
Projects
None yet
Development

No branches or pull requests

3 participants