1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
Getting started
===============
Demo
----
This module provides support for including YouTube, Vimeo and PeerTube videos in Sphinx :code:`rst` documents.
This module defines directives, :code:`youtube`, :code:`vimeo` :code:`peertube` which insert videos from the respective platforms. They take a single, required argument, wich is the video ID:
.. code-block:: rst
.. youtube:: dQw4w9WgXcQ
.. youtube:: dQw4w9WgXcQ
:align: center
:aspect: 16:9
.. code-block:: rst
.. vimeo:: 148751763
.. vimeo:: 486557682
:align: center
:aspect: 16:9
.. code-block:: rst
.. peertube:: 327a21b3-374e-4373-8b2c-494c9f5e1f19
.. peertube:: 327a21b3-374e-4373-8b2c-494c9f5e1f19
:align: center
:aspect: 16:9
To link to a different instance than the default :code:`peertube.tv` of the peertube platform, use the :code:`instance` keyword:
.. code-block:: rst
.. peertube:: 9732a818-9fed-4bb2-8469-9502a695cb4d
:instance: tube.kockatoo.org
.. peertube:: 9732a818-9fed-4bb2-8469-9502a695cb4d
:align: center
:aspect: 16:9
:instance: tube.kockatoo.org
Usage
-----
The referenced video will be embedded into HTML and LaTeX outputs, the behaviour will be different as LaTeX cannot display videos.
Installation
^^^^^^^^^^^^
The package is avalaible on `pipy <https://pypi.org/project/sphinxcontrib-youtube/1.2.0/>`__ and can be installed with pip:
.. code-block:: console
pip install sphinxcontrib-youtube
Configuration
^^^^^^^^^^^^^
Add `"sphinxcontrib.youtube"` to the `extensions` list in :file:`conf.py`. For
example:
.. code-block:: python3
extensions = [
'sphinx.ext.intersphinx',
'sphinxcontrib.youtube'
]
HTML
^^^^
By default, the embedded video will be sized for 720p content. To control this, the parameters :code:`aspect`, :code:`width`, and :code:`height` may optionally be provided:
.. code-block:: rst
.. youtube:: dQw4w9WgXcQ
:width: 640
:height: 480
.. code-block:: rst
.. youtube:: dQw4w9WgXcQ
:aspect: 4:3
.. code-block:: rst
.. youtube:: dQw4w9WgXcQ
:width: 100%
.. code-block:: rst
.. youtube:: dQw4w9WgXcQ
:height: 200px
To set the alignment of the embedded video's iframe in the HTML output, an optional :code:`align` parameter can be specified, similar to the rst :code:`image` directive:
.. code-block:: rst
.. youtube:: dQw4w9WgXcQ
:align: center
For YouTube "privacy mode", use the directive option :privacy_mode: (and for vimeo, :url_parameters: ?dnt=1):
.. code-block:: rst
.. youtube:: dQw4w9WgXcQ
:privacy_mode:
To start the video at a specific time the parameter "url_parameters" may be used (quotes required for Vimeo videos):
.. code-block:: rst
.. youtube:: dQw4w9WgXcQ
:url_parameters: ?start=43
.. code-block:: rst
.. vimeo:: 486557682
:url_parameters: "#t=0m43s"
.. code-block:: rst
.. peertube:: 327a21b3-374e-4373-8b2c-494c9f5e1f19
:url_parameters: "?start=0s"
When generating the EPUB output, the videos will not be embedded. Instead, a link to the video will be added.
LaTeX
^^^^^
In LaTeX output, the following code will be emitted for the videos:
.. code-block:: latex
\sphinxcontribyoutube{https://youtu.be/}{dQw4w9WgXcQ}{?start=43}
.. code-block:: latex
\sphinxcontribvimeo{https://player.vimeo.com/video/}{148751763}{"#t=0m43s"}
.. code-block:: latex
\sphinxcontribpeertube{https://peertube.tv/w/}{327a21b3-374e-4373-8b2c-494c9f5e1f19}{?start=43}
The user may customise the rendering of the URL by defining this command in the preamble. The captions will be downloaded to the latex folder and can thus be used as images in the :code:`.pdf` document. We are using the `Vumbnail <https://vumbnail.com>`__ (vimeo) and `get-youtube-thumbnail <https://www.get-youtube-thumbnail.com>`__ (youtube) web services to retrieve them. Here is an example of custom command for both the vimeo and the yoututbe output. This needs to be added in the :code:`conf.py` file:
.. code-block:: python
# conf.py
# ...
# -- Option for LaTeX output ---------------------------------------------------
# create a custom sphinx output for the youtube and vimeo video
youtube_cmd = r"\newcommand{\sphinxcontribyoutube}[3]{\begin{figure}\sphinxincludegraphics{{#2}.jpg}\caption{\url{#1#2#3}}\end{figure}}" + "\n"
vimeo_cmd = r"\newcommand{\sphinxcontribvimeo}[3]{\begin{figure}\sphinxincludegraphics{{#2}.jpg}\caption{\url{#1#2#3}}\end{figure}}" + "\n"
latex_elements = {"preamble": youtube_cmd + vimeo_cmd}
This example will show the video as a figure using the thumbnail as image and the url as caption (clickable link). This is the one we use for this very documentation. remember that the argument of your command are the following:
- :code:`#1`: the platform url
- :code:`#2`: the video ID (it's also the name of the image: :code:`#2.jpg`
- :code:`#3`: the options of the url
If no custom command is set in :code:`conf.py`, then the default definition is used:
.. code-block:: latex
\newcommand{\sphinxcontribyoutube}[3]{\begin{quote}\begin{center}\fbox{\url{#1#2#3}}\end{center}\end{quote}}
This prints a simple link to the video, enclosed in a box. LaTeX support for Vimeo is similar, except that the macro is named :code:`\sphinxcontribvimeo`.
.. toctree::
:maxdepth: 2
:caption: Contents:
|
