Metadata-Version: 2.4
Name: sphinxcontrib-video
Version: 0.4.2
Summary: Allows embedding of HTML5 videos in sphinx
Author-email: Raphael Massabot <rmassabot@gmail.com>
License: Apache Software License
Project-URL: repository, https://github.com/sphinx-contrib/video
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
Requires-Python: >=3.9.0
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: sphinx
Provides-Extra: dev
Requires-Dist: mypy; extra == "dev"
Requires-Dist: nox; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Provides-Extra: test
Requires-Dist: beautifulsoup4; extra == "test"
Requires-Dist: defusedxml; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: pytest-regressions; extra == "test"
Provides-Extra: doc
Requires-Dist: pydata-sphinx-theme; extra == "doc"
Requires-Dist: sphinx-design; extra == "doc"
Dynamic: license-file

sphinxcontrib-video
===================

.. image:: https://img.shields.io/badge/License-Apache%202.0-yellow.svg
    :target: https://github.com/sphinx-contrib/video/blob/master/LICENSE
    :alt: License: MIT

.. image:: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg
   :target: https://conventionalcommits.org
   :alt: conventional commit

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/psf/black
   :alt: Black badge

.. image:: https://img.shields.io/badge/code_style-prettier-ff69b4.svg
   :target: https://github.com/prettier/prettier
   :alt: prettier badge

.. image:: https://img.shields.io/pypi/v/sphinxcontrib-video?color=blue&logo=python&logoColor=white
   :alt: PyPI
   :target: https://pypi.org/project/sphinxcontrib-video/

.. image:: https://img.shields.io/pypi/pyversions/sphinxcontrib-video?logo=python&logoColor=white
   :alt: PyPI - Python Version
   :target: https://pypi.org/project/sphinxcontrib-video/

.. image:: https://img.shields.io/readthedocs/sphinxcontrib-video?logo=readthedocs&logoColor=white
   :alt: Read the Docs
   :target: https://readthedocs.org/projects/sphinxcontrib-video/

.. image:: https://img.shields.io/codecov/c/github/sphinx-contrib/video?logo=codecov&logoColor=white
   :alt: Codecov
   :target: https://app.codecov.io/gh/sphinx-contrib/video

.. image:: https://img.shields.io/github/actions/workflow/status/sphinx-contrib/video/unit.yaml?logo=github&logoColor=white
   :alt: GitHub Workflow Status
   :target: https://github.com/sphinx-contrib/video/actions/workflows/unit.yaml

The video extension allows you to embed ``.mp4``/``.webm``/``.ogg`` videos as defined by the HTML5 standard. It's a wrapper around the ``<video>`` tag. using a simple directive as:

.. code-block:: rst

  .. video:: movie.mp4

will be rendered as:

.. code-block:: html

   <video>
      <source src="movie.mp4" type="video/mp4">
   </video>

The extension exposes pretty much all parameters from the HTML5 ``<video/>`` tag.

More information about installation and usage in our `documentation quickstart <https://sphinxcontrib-video.readthedocs.io/en/latest/quickstart.html>`__.
