Skip to content

Commit

Permalink
Updated docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
@ggarra13
ggarra13 committed Oct 26, 2023
1 parent 2e3a69b commit f7c81f0
Show file tree
Hide file tree
Showing 14 changed files with 588 additions and 477 deletions.
2 changes: 1 addition & 1 deletion mrv2/docs/en/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ <h2 id="A">A</h2>
</li>
<li><a href="python_api/annotations.html#mrv2.annotations.add">add() (in module mrv2.annotations)</a>
</li>
<li><a href="python_api/playlist.html#mrv2.playlist.add_clip">add_clip() (in module mrv2.playlist)</a>
<li><a href="python_api/playlist.html#mrv2.playlist.addClip">addClip() (in module mrv2.playlist)</a>
</li>
<li><a href="python_api/media.html#mrv2.media.Afile">Afile() (in module mrv2.media)</a>
</li>
Expand Down
Binary file modified mrv2/docs/en/objects.inv
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion mrv2/docs/en/python_api/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="playlist.html">playlist module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="playlist.html#mrv2.playlist.add_clip"><code class="docutils literal notranslate"><span class="pre">add_clip()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="playlist.html#mrv2.playlist.addClip"><code class="docutils literal notranslate"><span class="pre">addClip()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="playlist.html#mrv2.playlist.list"><code class="docutils literal notranslate"><span class="pre">list()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="playlist.html#mrv2.playlist.save"><code class="docutils literal notranslate"><span class="pre">save()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="playlist.html#mrv2.playlist.select"><code class="docutils literal notranslate"><span class="pre">select()</span></code></a></li>
Expand Down
6 changes: 3 additions & 3 deletions mrv2/docs/en/python_api/playlist.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<li class="toctree-l2"><a class="reference internal" href="media.html">media module</a></li>
<li class="toctree-l2"><a class="reference internal" href="mrv2.html">mrv2 module</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">playlist module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.playlist.add_clip"><code class="docutils literal notranslate"><span class="pre">add_clip()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.playlist.addClip"><code class="docutils literal notranslate"><span class="pre">addClip()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.playlist.list"><code class="docutils literal notranslate"><span class="pre">list()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.playlist.save"><code class="docutils literal notranslate"><span class="pre">save()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.playlist.select"><code class="docutils literal notranslate"><span class="pre">select()</span></code></a></li>
Expand Down Expand Up @@ -103,8 +103,8 @@
<p>Playlist module.</p>
<p>Contains all functions and classes related to the playlists.</p>
<dl class="py function">
<dt class="sig sig-object py" id="mrv2.playlist.add_clip">
<span class="sig-prename descclassname"><span class="pre">mrv2.playlist.</span></span><span class="sig-name descname"><span class="pre">add_clip</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">clip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="mrv2.html#mrv2.FileMedia" title="mrv2.FileMedia"><span class="pre">mrv2.FileMedia</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#mrv2.playlist.add_clip" title="Link to this definition"></a></dt>
<dt class="sig sig-object py" id="mrv2.playlist.addClip">
<span class="sig-prename descclassname"><span class="pre">mrv2.playlist.</span></span><span class="sig-name descname"><span class="pre">addClip</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">clip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="mrv2.html#mrv2.FileMedia" title="mrv2.FileMedia"><span class="pre">mrv2.FileMedia</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#mrv2.playlist.addClip" title="Link to this definition"></a></dt>
<dd><p>Add a clip to currently selected Playlist EDL.</p>
</dd></dl>

Expand Down
2 changes: 1 addition & 1 deletion mrv2/docs/en/searchindex.js
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion mrv2/docs/es/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ <h2 id="A">A</h2>
</li>
<li><a href="python_api/annotations.html#mrv2.annotations.add">add() (en el módulo mrv2.annotations)</a>
</li>
<li><a href="python_api/playlist.html#mrv2.playlist.add_clip">add_clip() (en el módulo mrv2.playlist)</a>
<li><a href="python_api/playlist.html#mrv2.playlist.addClip">addClip() (en el módulo mrv2.playlist)</a>
</li>
<li><a href="python_api/media.html#mrv2.media.Afile">Afile() (en el módulo mrv2.media)</a>
</li>
Expand Down
Binary file modified mrv2/docs/es/objects.inv
View file
Binary file not shown.
24 changes: 12 additions & 12 deletions mrv2/docs/es/python_api/image.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -282,35 +282,35 @@
<dl class="py class">
<dt class="sig sig-object py" id="mrv2.image.BackgroundOptions">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mrv2.image.</span></span><span class="sig-name descname"><span class="pre">BackgroundOptions</span></span><a class="headerlink" href="#mrv2.image.BackgroundOptions" title="Link to this definition"></a></dt>
<dd><p>Background options.</p>
<dd><p>Opciones de Fondo.</p>
<dl class="py property">
<dt class="sig sig-object py" id="mrv2.image.BackgroundOptions.checkersColor0">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">checkersColor0</span></span><a class="headerlink" href="#mrv2.image.BackgroundOptions.checkersColor0" title="Link to this definition"></a></dt>
<dd><p>Checkers Color0 <a class="reference internal" href="#mrv2.image.Color4f" title="mrv2.image.Color4f"><code class="xref py py-class docutils literal notranslate"><span class="pre">mrv2.image.Color4f</span></code></a>..</p>
<dd><p>Opciones de Color0 del cuadriculado <a class="reference internal" href="#mrv2.image.Color4f" title="mrv2.image.Color4f"><code class="xref py py-class docutils literal notranslate"><span class="pre">mrv2.image.Color4f</span></code></a>.</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="mrv2.image.BackgroundOptions.checkersColor1">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">checkersColor1</span></span><a class="headerlink" href="#mrv2.image.BackgroundOptions.checkersColor1" title="Link to this definition"></a></dt>
<dd><p>Checkers Color1 <a class="reference internal" href="#mrv2.image.Color4f" title="mrv2.image.Color4f"><code class="xref py py-class docutils literal notranslate"><span class="pre">mrv2.image.Color4f</span></code></a>..</p>
<dd><p>Opciones de Color1 del cuadriculado <a class="reference internal" href="#mrv2.image.Color4f" title="mrv2.image.Color4f"><code class="xref py py-class docutils literal notranslate"><span class="pre">mrv2.image.Color4f</span></code></a>.</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="mrv2.image.BackgroundOptions.checkersSize">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">checkersSize</span></span><a class="headerlink" href="#mrv2.image.BackgroundOptions.checkersSize" title="Link to this definition"></a></dt>
<dd><p>Checkers Size <a class="reference internal" href="math.html#mrv2.math.Size2i" title="mrv2.math.Size2i"><code class="xref py py-class docutils literal notranslate"><span class="pre">mrv2.math.Size2i</span></code></a>..</p>
<dd><p>Tamaño del Cuadriculado <a class="reference internal" href="math.html#mrv2.math.Size2i" title="mrv2.math.Size2i"><code class="xref py py-class docutils literal notranslate"><span class="pre">mrv2.math.Size2i</span></code></a>..</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="mrv2.image.BackgroundOptions.solidColor">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">solidColor</span></span><a class="headerlink" href="#mrv2.image.BackgroundOptions.solidColor" title="Link to this definition"></a></dt>
<dd><p>Solid Color <a class="reference internal" href="#mrv2.image.Color4f" title="mrv2.image.Color4f"><code class="xref py py-class docutils literal notranslate"><span class="pre">mrv2.image.Color4f</span></code></a>..</p>
<dd><p>Opciones de Color Sólido <a class="reference internal" href="#mrv2.image.Color4f" title="mrv2.image.Color4f"><code class="xref py py-class docutils literal notranslate"><span class="pre">mrv2.image.Color4f</span></code></a>..</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="mrv2.image.BackgroundOptions.type">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><a class="headerlink" href="#mrv2.image.BackgroundOptions.type" title="Link to this definition"></a></dt>
<dd><p>Background type <a class="reference internal" href="#mrv2.image.Background" title="mrv2.image.Background"><code class="xref py py-class docutils literal notranslate"><span class="pre">mrv2.image.Background</span></code></a>..</p>
<dd><p>Tipo de fondo <a class="reference internal" href="#mrv2.image.Background" title="mrv2.image.Background"><code class="xref py py-class docutils literal notranslate"><span class="pre">mrv2.image.Background</span></code></a>..</p>
</dd></dl>

</dd></dl>
Expand Down Expand Up @@ -517,7 +517,7 @@
<dl class="py function">
<dt class="sig sig-object py" id="mrv2.image.backgroundOptions">
<span class="sig-prename descclassname"><span class="pre">mrv2.image.</span></span><span class="sig-name descname"><span class="pre">backgroundOptions</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#mrv2.image.BackgroundOptions" title="mrv2.image.BackgroundOptions"><span class="pre">mrv2.image.BackgroundOptions</span></a></span></span><a class="headerlink" href="#mrv2.image.backgroundOptions" title="Link to this definition"></a></dt>
<dd><p>Gets the current background options.</p>
<dd><p>Retorna las opciones actual del fondo.</p>
</dd></dl>

<dl class="py function">
Expand Down Expand Up @@ -547,7 +547,7 @@
<dl class="py function">
<dt class="sig sig-object py" id="mrv2.image.setBackgroundOptions">
<span class="sig-prename descclassname"><span class="pre">mrv2.image.</span></span><span class="sig-name descname"><span class="pre">setBackgroundOptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mrv2.image.BackgroundOptions" title="mrv2.image.BackgroundOptions"><span class="pre">mrv2.image.BackgroundOptions</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#mrv2.image.setBackgroundOptions" title="Link to this definition"></a></dt>
<dd><p>Sets the current background options.</p>
<dd><p>Setea las opciones de fondo.</p>
</dd></dl>

<dl class="py function">
Expand Down Expand Up @@ -591,25 +591,25 @@
<dl class="py attribute">
<dt class="sig sig-object py" id="mrv2.image.Color4f.r">
<span class="sig-name descname"><span class="pre">r</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">float</span></em><a class="headerlink" href="#mrv2.image.Color4f.r" title="Link to this definition"></a></dt>
<dd><p>Red Channel.</p>
<dd><p>Canal Rojo.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="mrv2.image.Color4f.g">
<span class="sig-name descname"><span class="pre">g</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">float</span></em><a class="headerlink" href="#mrv2.image.Color4f.g" title="Link to this definition"></a></dt>
<dd><p>Green Channel.</p>
<dd><p>Canal Verde.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="id0">
<span class="sig-name descname"><span class="pre">g</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">float</span></em><a class="headerlink" href="#id0" title="Link to this definition"></a></dt>
<dd><p>Green Channel.</p>
<dd><p>Canal Verde.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="mrv2.image.Color4f.a">
<span class="sig-name descname"><span class="pre">a</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">float</span></em><a class="headerlink" href="#mrv2.image.Color4f.a" title="Link to this definition"></a></dt>
<dd><p>Alpha Channel.</p>
<dd><p>Canal Alfa.</p>
</dd></dl>

</dd></dl>
Expand Down
2 changes: 1 addition & 1 deletion mrv2/docs/es/python_api/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="playlist.html">Módulo playlist</a><ul>
<li class="toctree-l2"><a class="reference internal" href="playlist.html#mrv2.playlist.add_clip"><code class="docutils literal notranslate"><span class="pre">add_clip()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="playlist.html#mrv2.playlist.addClip"><code class="docutils literal notranslate"><span class="pre">addClip()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="playlist.html#mrv2.playlist.list"><code class="docutils literal notranslate"><span class="pre">list()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="playlist.html#mrv2.playlist.save"><code class="docutils literal notranslate"><span class="pre">save()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="playlist.html#mrv2.playlist.select"><code class="docutils literal notranslate"><span class="pre">select()</span></code></a></li>
Expand Down
2 changes: 1 addition & 1 deletion mrv2/docs/es/python_api/math.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@
<dl class="py class">
<dt class="sig sig-object py" id="mrv2.math.Size2i">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mrv2.math.</span></span><span class="sig-name descname"><span class="pre">Size2i</span></span><a class="headerlink" href="#mrv2.math.Size2i" title="Link to this definition"></a></dt>
<dd><p>Size of 2 integers.</p>
<dd><p>Tamaño de 2 enteros.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="mrv2.math.Size2i.w">
<span class="sig-name descname"><span class="pre">w</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">int</span></em><a class="headerlink" href="#mrv2.math.Size2i.w" title="Link to this definition"></a></dt>
Expand Down
6 changes: 3 additions & 3 deletions mrv2/docs/es/python_api/playlist.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
<li class="toctree-l2"><a class="reference internal" href="media.html">Módulo media</a></li>
<li class="toctree-l2"><a class="reference internal" href="mrv2.html">Módulo mrv2</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Módulo playlist</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.playlist.add_clip"><code class="docutils literal notranslate"><span class="pre">add_clip()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.playlist.addClip"><code class="docutils literal notranslate"><span class="pre">addClip()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.playlist.list"><code class="docutils literal notranslate"><span class="pre">list()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.playlist.save"><code class="docutils literal notranslate"><span class="pre">save()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.playlist.select"><code class="docutils literal notranslate"><span class="pre">select()</span></code></a></li>
Expand Down Expand Up @@ -104,8 +104,8 @@
<p>Mòdulo de lista de reproducción.</p>
<p>Contiene todas las clases y enums relacionados con las listas dereproducción.</p>
<dl class="py function">
<dt class="sig sig-object py" id="mrv2.playlist.add_clip">
<span class="sig-prename descclassname"><span class="pre">mrv2.playlist.</span></span><span class="sig-name descname"><span class="pre">add_clip</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">clip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="mrv2.html#mrv2.FileMedia" title="mrv2.FileMedia"><span class="pre">mrv2.FileMedia</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#mrv2.playlist.add_clip" title="Link to this definition"></a></dt>
<dt class="sig sig-object py" id="mrv2.playlist.addClip">
<span class="sig-prename descclassname"><span class="pre">mrv2.playlist.</span></span><span class="sig-name descname"><span class="pre">addClip</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">clip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="mrv2.html#mrv2.FileMedia" title="mrv2.FileMedia"><span class="pre">mrv2.FileMedia</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#mrv2.playlist.addClip" title="Link to this definition"></a></dt>
<dd><p>Agregar clip a la lista de reproducción (EDL) seleccionada.</p>
</dd></dl>

Expand Down
2 changes: 1 addition & 1 deletion mrv2/docs/es/searchindex.js
View file

Large diffs are not rendered by default.

Loading

0 comments on commit f7c81f0

Please sign in to comment.