Merge branch 'yt-contrib' into 'main'

Switch to sphinxcontrib-youtube

See merge request docs/docs.beagleboard.io!91

boards/beagleconnect/freedom/02-quick-start.rst

@@ -15,25 +15,10 @@ What's included in the box?
 
    Image with what's inside the box and a better description.
 
-.. only:: latex
-    
-   .. image:: https://img.youtube.com/vi/bJYZ6PTiV9g/maxresdefault.jpg
-      :alt: BeagleConnect unboxing YouTube video
-      :width: 1280
-      :target: https://www.youtube.com/watch?v=bJYZ6PTiV9g
-
-.. only:: html
-
-    .. raw:: html
-
-        <iframe style="display: block; margin: auto;" width="1280" height="720" style="align:center" 
-        src="https://www.youtube.com/embed/bJYZ6PTiV9g" 
-        title="YouTube video player" 
-        frameborder="0" 
-        allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" 
-        allowfullscreen>
-        </iframe>
-
+.. youtube:: bJYZ6PTiV9g
+   :align: center
+   :width: 1280
+   :height: 720
 
 Attaching antenna
 ******************

boards/beagleplay/02-quick-start.rst

@@ -24,24 +24,10 @@ Attaching antennas
 
 You can watch this video to see how to attach the attennas.
 
-.. only:: latex
-    
-    .. image:: images/attach-antennas.*
-        :alt: YouTube video of BeaglePlay antenna connection
-        :width: 1280
-        :target: https://youtu.be/8zeIVd-JRc0
-
-.. only:: html
-
-    .. raw:: html
-
-        <iframe style="display: block; margin: auto;" width="1280" height="720" style="align:center" 
-        src="https://www.youtube.com/embed/8zeIVd-JRc0" 
-        title="YouTube video player" 
-        frameborder="0" 
-        allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" 
-        allowfullscreen>
-        </iframe>
+.. youtube:: 8zeIVd-JRc0
+    :width: 1280
+    :height: 720
+    :align: center
 
 Tethering to PC
 ****************

boards/beaglev/ahead/02-quick-start.rst

@@ -21,25 +21,10 @@ When you purchase a brand new BeagleV Ahead, In the box you'll get:
 Unboxing
 *********
 
-.. only:: latex
-    
-   .. image:: https://img.youtube.com/vi/SVC9peUUzE0/maxresdefault.jpg
-      :alt: BeagleV Ahead Unboxing YouTube video
-      :width: 1280
-      :target: https://www.youtube.com/watch?v=SVC9peUUzE0
-
-.. only:: html
-
-    .. raw:: html
-
-        <iframe style="display: block; margin: auto;" width="1280" height="720" style="align:center" 
-        src="https://www.youtube.com/embed/SVC9peUUzE0" 
-        title="YouTube video player" 
-        frameborder="0" 
-        allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" 
-        allowfullscreen>
-        </iframe>
-
+.. youtube:: SVC9peUUzE0
+   :width: 1280
+   :height: 720
+   :align: center
 
 Antenna guide
 *************

boards/beaglev/fire/02-quick-start.rst

@@ -13,24 +13,10 @@ When you purchase a brand new BeagleV-Fire, In the box you'll get:
 Unboxing
 *********
 
-.. only:: latex
-    
-   .. image:: https://img.youtube.com/vi/5cylv1R-1mc/maxresdefault.jpg
-      :alt: BeagleV Ahead Unboxing YouTube video
-      :width: 1280
-      :target: https://www.youtube.com/watch?v=5cylv1R-1mc
-
-.. only:: html
-
-    .. raw:: html
-
-        <iframe style="display: block; margin: auto;" width="1280" height="720" style="align:center" 
-        src="https://www.youtube.com/embed/5cylv1R-1mc" 
-        title="YouTube video player" 
-        frameborder="0" 
-        allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" 
-        allowfullscreen>
-        </iframe>
+.. youtube:: 5cylv1R-1mc
+   :align: center
+   :width: 1280
+   :height: 720
 
 
 Tethering to PC

conf.py

@@ -45,6 +45,7 @@ extensions = [
     "sphinx_tabs.tabs",
     "breathe",
     "sphinx_copybutton",
+    "sphinxcontrib.youtube",
 ]
 
 #    "exhale"

intro/contribution/rst-cheat-sheet.rst

@@ -314,33 +314,11 @@ When rendered it becomes :ref:`rst-cheat-sheet`.
 YouTube Videos
 ==============
 
-This section shows you the typical way of adding a YouTube video to 
-docs.BeagleBoard.org in a way that you see on page playable embedded 
-YouTube video when you look at HTML version of the docs and only a 
-clicable thumnail linked to the YouTube video when you see the PDF. 
+This site uses sphinxcontrib-youtube to embed YouTube videos. The syntax is as follows:
 
 .. callout::
 
-    .. code-block:: rst
-
-        .. only:: latex
-            
-            .. image:: https://img.youtube.com/vi/<YouTube_video_ID>/maxresdefault.jpg <1>
-                :alt: BeagleConnect unboxing YouTube video
-                :width: 1280
-                :target: https://www.youtube.com/watch?v=<YouTube_video_ID> <2>
-
-        .. only:: html
-
-            .. raw:: html
-
-                <iframe style="display: block; margin: auto;" width="1280" height="720" style="align:center" 
-                src="https://www.youtube.com/embed/<YouTube_video_ID>" <3>
-                title="YouTube video player" 
-                frameborder="0" 
-                allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" 
-                allowfullscreen>
-            </iframe>
+    .. youtube:: <YouTube_video_ID>
     
     .. annotations::
 

requirements.txt

@@ -34,5 +34,6 @@ sphinxcontrib-jsmath==1.0.1
 sphinxcontrib-qthelp==1.0.6
 sphinxcontrib-serializinghtml==1.1.9
 sphinxcontrib-svg2pdfconverter==1.2.2
+sphinxcontrib-youtube==1.4.1
 tornado==6.4
 urllib3==2.1.0