Skip to content

Commit

Permalink
Updated docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
@ggarra13
ggarra13 committed Aug 24, 2024
1 parent a384731 commit a3491b2
Show file tree
Hide file tree
Showing 25 changed files with 592 additions and 463 deletions.
Binary file modified docs/www/files/mrv2.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 10 additions & 2 deletions mrv2/docs/en/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,8 @@ <h2 id="C">C</h2>
<li><a href="python_api/media.html#mrv2.media.CompareOptions">CompareOptions (class in mrv2.media)</a>
</li>
<li><a href="python_api/cmd.html#mrv2.cmd.compareOptions">compareOptions() (in module mrv2.cmd)</a>
</li>
<li><a href="python_api/media.html#mrv2.media.CompareTimeMode">CompareTimeMode (class in mrv2.media)</a>
</li>
<li><a href="python_api/usd.html#mrv2.usd.RenderOptions.complexity">complexity (mrv2.usd.RenderOptions attribute)</a>
</li>
Expand Down Expand Up @@ -344,6 +346,8 @@ <h2 id="G">G</h2>
<li><a href="python_api/mrv2.html#mrv2.Path.get">get() (mrv2.Path method)</a>
</li>
<li><a href="python_api/mrv2.html#mrv2.Path.getBaseName">getBaseName() (mrv2.Path method)</a>
</li>
<li><a href="python_api/media.html#mrv2.media.getCompareTime">getCompareTime() (in module mrv2.media)</a>
</li>
<li><a href="python_api/mrv2.html#mrv2.Path.getDirectory">getDirectory() (mrv2.Path method)</a>
</li>
Expand Down Expand Up @@ -658,6 +662,8 @@ <h2 id="N">N</h2>
<li><a href="python_api/io.html#mrv2.io.AudioCodec.name">(mrv2.io.AudioCodec property)</a>
</li>
<li><a href="python_api/io.html#mrv2.io.Resolution.name">(mrv2.io.Resolution property)</a>
</li>
<li><a href="python_api/media.html#mrv2.media.CompareTimeMode.name">(mrv2.media.CompareTimeMode property)</a>
</li>
<li><a href="python_api/timeline.html#mrv2.timeline.FileSequenceAudio.name">(mrv2.timeline.FileSequenceAudio property)</a>
</li>
Expand Down Expand Up @@ -815,6 +821,8 @@ <h2 id="S">S</h2>
<li><a href="python_api/image.html#mrv2.image.setBackgroundOptions">setBackgroundOptions() (in module mrv2.image)</a>
</li>
<li><a href="python_api/cmd.html#mrv2.cmd.setCompareOptions">setCompareOptions() (in module mrv2.cmd)</a>
</li>
<li><a href="python_api/media.html#mrv2.media.setCompareTime">setCompareTime() (in module mrv2.media)</a>
</li>
<li><a href="python_api/session.html#mrv2.session.setCurrent">setCurrent() (in module mrv2.session)</a>
</li>
Expand All @@ -837,11 +845,11 @@ <h2 id="S">S</h2>
<li><a href="python_api/settings.html#mrv2.settings.setMemory">setMemory() (in module mrv2.settings)</a>
</li>
<li><a href="python_api/session.html#mrv2.session.setMetadata">setMetadata() (in module mrv2.session)</a>
</li>
<li><a href="python_api/cmd.html#mrv2.cmd.setMute">setMute() (in module mrv2.cmd)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="python_api/cmd.html#mrv2.cmd.setMute">setMute() (in module mrv2.cmd)</a>
</li>
<li><a href="python_api/image.html#mrv2.image.setOcioConfig">setOcioConfig() (in module mrv2.image)</a>
</li>
<li><a href="python_api/image.html#mrv2.image.setOcioIcs">setOcioIcs() (in module mrv2.image)</a>
Expand Down
Binary file modified mrv2/docs/en/objects.inv
View file
Binary file not shown.
3 changes: 3 additions & 0 deletions mrv2/docs/en/python_api/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -205,18 +205,21 @@
<li class="toctree-l2"><a class="reference internal" href="media.html#mrv2.media.Aindex"><code class="docutils literal notranslate"><span class="pre">Aindex()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="media.html#mrv2.media.BIndexes"><code class="docutils literal notranslate"><span class="pre">BIndexes()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="media.html#mrv2.media.Bfiles"><code class="docutils literal notranslate"><span class="pre">Bfiles()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="media.html#mrv2.media.CompareTimeMode"><code class="docutils literal notranslate"><span class="pre">CompareTimeMode</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="media.html#mrv2.media.activeFiles"><code class="docutils literal notranslate"><span class="pre">activeFiles()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="media.html#mrv2.media.clearB"><code class="docutils literal notranslate"><span class="pre">clearB()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="media.html#mrv2.media.close"><code class="docutils literal notranslate"><span class="pre">close()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="media.html#mrv2.media.closeAll"><code class="docutils literal notranslate"><span class="pre">closeAll()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="media.html#mrv2.media.firstVersion"><code class="docutils literal notranslate"><span class="pre">firstVersion()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="media.html#mrv2.media.getCompareTime"><code class="docutils literal notranslate"><span class="pre">getCompareTime()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="media.html#mrv2.media.lastVersion"><code class="docutils literal notranslate"><span class="pre">lastVersion()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="media.html#mrv2.media.layers"><code class="docutils literal notranslate"><span class="pre">layers()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="media.html#mrv2.media.list"><code class="docutils literal notranslate"><span class="pre">list()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="media.html#mrv2.media.nextVersion"><code class="docutils literal notranslate"><span class="pre">nextVersion()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="media.html#mrv2.media.previousVersion"><code class="docutils literal notranslate"><span class="pre">previousVersion()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="media.html#mrv2.media.setA"><code class="docutils literal notranslate"><span class="pre">setA()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="media.html#mrv2.media.setB"><code class="docutils literal notranslate"><span class="pre">setB()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="media.html#mrv2.media.setCompareTime"><code class="docutils literal notranslate"><span class="pre">setCompareTime()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="media.html#mrv2.media.setLayer"><code class="docutils literal notranslate"><span class="pre">setLayer()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="media.html#mrv2.media.setStereo"><code class="docutils literal notranslate"><span class="pre">setStereo()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="media.html#mrv2.media.toggleB"><code class="docutils literal notranslate"><span class="pre">toggleB()</span></code></a></li>
Expand Down
31 changes: 31 additions & 0 deletions mrv2/docs/en/python_api/media.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,18 +60,24 @@
<li class="toctree-l3"><a class="reference internal" href="#mrv2.media.Aindex"><code class="docutils literal notranslate"><span class="pre">Aindex()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.media.BIndexes"><code class="docutils literal notranslate"><span class="pre">BIndexes()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.media.Bfiles"><code class="docutils literal notranslate"><span class="pre">Bfiles()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.media.CompareTimeMode"><code class="docutils literal notranslate"><span class="pre">CompareTimeMode</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#mrv2.media.CompareTimeMode.name"><code class="docutils literal notranslate"><span class="pre">CompareTimeMode.name</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.media.activeFiles"><code class="docutils literal notranslate"><span class="pre">activeFiles()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.media.clearB"><code class="docutils literal notranslate"><span class="pre">clearB()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.media.close"><code class="docutils literal notranslate"><span class="pre">close()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.media.closeAll"><code class="docutils literal notranslate"><span class="pre">closeAll()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.media.firstVersion"><code class="docutils literal notranslate"><span class="pre">firstVersion()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.media.getCompareTime"><code class="docutils literal notranslate"><span class="pre">getCompareTime()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.media.lastVersion"><code class="docutils literal notranslate"><span class="pre">lastVersion()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.media.layers"><code class="docutils literal notranslate"><span class="pre">layers()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.media.list"><code class="docutils literal notranslate"><span class="pre">list()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.media.nextVersion"><code class="docutils literal notranslate"><span class="pre">nextVersion()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.media.previousVersion"><code class="docutils literal notranslate"><span class="pre">previousVersion()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.media.setA"><code class="docutils literal notranslate"><span class="pre">setA()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.media.setB"><code class="docutils literal notranslate"><span class="pre">setB()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.media.setCompareTime"><code class="docutils literal notranslate"><span class="pre">setCompareTime()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.media.setLayer"><code class="docutils literal notranslate"><span class="pre">setLayer()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.media.setStereo"><code class="docutils literal notranslate"><span class="pre">setStereo()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.media.toggleB"><code class="docutils literal notranslate"><span class="pre">toggleB()</span></code></a></li>
Expand Down Expand Up @@ -152,6 +158,19 @@
<dd><p>Return the list of B files.</p>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="mrv2.media.CompareTimeMode">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mrv2.media.</span></span><span class="sig-name descname"><span class="pre">CompareTimeMode</span></span><a class="headerlink" href="#mrv2.media.CompareTimeMode" title="Link to this definition"></a></dt>
<dd><p>Members:</p>
<p>Relative</p>
<p>Absolute</p>
<dl class="py property">
<dt class="sig sig-object py" id="mrv2.media.CompareTimeMode.name">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#mrv2.media.CompareTimeMode.name" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="mrv2.media.activeFiles">
<span class="sig-prename descclassname"><span class="pre">mrv2.media.</span></span><span class="sig-name descname"><span class="pre">activeFiles</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"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="mrv2.html#mrv2.FileMedia" title="mrv2.FileMedia"><span class="pre">mrv2.FileMedia</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mrv2.media.activeFiles" title="Link to this definition"></a></dt>
Expand Down Expand Up @@ -182,6 +201,12 @@
<dd><p>Set the first version for current media.</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="mrv2.media.getCompareTime">
<span class="sig-prename descclassname"><span class="pre">mrv2.media.</span></span><span class="sig-name descname"><span class="pre">getCompareTime</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.media.CompareTimeMode" title="mrv2.media.CompareTimeMode"><span class="pre">mrv2.media.CompareTimeMode</span></a></span></span><a class="headerlink" href="#mrv2.media.getCompareTime" title="Link to this definition"></a></dt>
<dd><p>Get compare time.</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="mrv2.media.lastVersion">
<span class="sig-prename descclassname"><span class="pre">mrv2.media.</span></span><span class="sig-name descname"><span class="pre">lastVersion</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"><span class="pre">None</span></span></span><a class="headerlink" href="#mrv2.media.lastVersion" title="Link to this definition"></a></dt>
Expand Down Expand Up @@ -224,6 +249,12 @@
<dd><p>Set a new B file index.</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="mrv2.media.setCompareTime">
<span class="sig-prename descclassname"><span class="pre">mrv2.media.</span></span><span class="sig-name descname"><span class="pre">setCompareTime</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mrv2.media.CompareTimeMode" title="mrv2.media.CompareTimeMode"><span class="pre">mrv2.media.CompareTimeMode</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.media.setCompareTime" title="Link to this definition"></a></dt>
<dd><p>Set compare time.</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="mrv2.media.setLayer">
<span class="sig-prename descclassname"><span class="pre">mrv2.media.</span></span><span class="sig-name descname"><span class="pre">setLayer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</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>, <em class="sig-param"><span class="n"><span class="pre">layer</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></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.media.setLayer" title="Link to this definition"></a></dt>
Expand Down
2 changes: 1 addition & 1 deletion mrv2/docs/en/searchindex.js
View file

Large diffs are not rendered by default.

12 changes: 10 additions & 2 deletions mrv2/docs/es/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,8 @@ <h2 id="C">C</h2>
<li><a href="python_api/media.html#mrv2.media.CompareOptions">CompareOptions (clase en mrv2.media)</a>
</li>
<li><a href="python_api/cmd.html#mrv2.cmd.compareOptions">compareOptions() (en el módulo mrv2.cmd)</a>
</li>
<li><a href="python_api/media.html#mrv2.media.CompareTimeMode">CompareTimeMode (clase en mrv2.media)</a>
</li>
<li><a href="python_api/usd.html#mrv2.usd.RenderOptions.complexity">complexity (atributo de mrv2.usd.RenderOptions)</a>
</li>
Expand Down Expand Up @@ -345,6 +347,8 @@ <h2 id="G">G</h2>
<li><a href="python_api/mrv2.html#mrv2.Path.get">get() (método de mrv2.Path)</a>
</li>
<li><a href="python_api/mrv2.html#mrv2.Path.getBaseName">getBaseName() (método de mrv2.Path)</a>
</li>
<li><a href="python_api/media.html#mrv2.media.getCompareTime">getCompareTime() (en el módulo mrv2.media)</a>
</li>
<li><a href="python_api/mrv2.html#mrv2.Path.getDirectory">getDirectory() (método de mrv2.Path)</a>
</li>
Expand Down Expand Up @@ -659,6 +663,8 @@ <h2 id="N">N</h2>
<li><a href="python_api/io.html#mrv2.io.AudioCodec.name">(mrv2.io.AudioCodec propiedad)</a>
</li>
<li><a href="python_api/io.html#mrv2.io.Resolution.name">(mrv2.io.Resolution propiedad)</a>
</li>
<li><a href="python_api/media.html#mrv2.media.CompareTimeMode.name">(mrv2.media.CompareTimeMode propiedad)</a>
</li>
<li><a href="python_api/timeline.html#mrv2.timeline.FileSequenceAudio.name">(mrv2.timeline.FileSequenceAudio propiedad)</a>
</li>
Expand Down Expand Up @@ -816,6 +822,8 @@ <h2 id="S">S</h2>
<li><a href="python_api/image.html#mrv2.image.setBackgroundOptions">setBackgroundOptions() (en el módulo mrv2.image)</a>
</li>
<li><a href="python_api/cmd.html#mrv2.cmd.setCompareOptions">setCompareOptions() (en el módulo mrv2.cmd)</a>
</li>
<li><a href="python_api/media.html#mrv2.media.setCompareTime">setCompareTime() (en el módulo mrv2.media)</a>
</li>
<li><a href="python_api/session.html#mrv2.session.setCurrent">setCurrent() (en el módulo mrv2.session)</a>
</li>
Expand All @@ -838,11 +846,11 @@ <h2 id="S">S</h2>
<li><a href="python_api/settings.html#mrv2.settings.setMemory">setMemory() (en el módulo mrv2.settings)</a>
</li>
<li><a href="python_api/session.html#mrv2.session.setMetadata">setMetadata() (en el módulo mrv2.session)</a>
</li>
<li><a href="python_api/cmd.html#mrv2.cmd.setMute">setMute() (en el módulo mrv2.cmd)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="python_api/cmd.html#mrv2.cmd.setMute">setMute() (en el módulo mrv2.cmd)</a>
</li>
<li><a href="python_api/image.html#mrv2.image.setOcioConfig">setOcioConfig() (en el módulo mrv2.image)</a>
</li>
<li><a href="python_api/image.html#mrv2.image.setOcioIcs">setOcioIcs() (en el módulo mrv2.image)</a>
Expand Down
Binary file modified mrv2/docs/es/objects.inv
View file
Binary file not shown.
Loading

0 comments on commit a3491b2

Please sign in to comment.