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 20, 2023
1 parent 67ac7b7 commit 4d14092
Show file tree
Hide file tree
Showing 44 changed files with 60 additions and 60 deletions.
2 changes: 1 addition & 1 deletion docs/sphinx/en/python_api/session.rst
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Session module
session Module
==============

.. automodule:: mrv2.session
Expand Down
4 changes: 2 additions & 2 deletions docs/sphinx/es/python_api/session.rst
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Módulo de Sesión
================
Módulo session
==============

.. automodule:: mrv2.session
:members:
2 changes: 1 addition & 1 deletion mrv2/docs/en/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 48b784a9235c1c7a657c0806b86322e5
config: 3bed6507af48dcb1fabb1871af566283
tags: 645f666f9bcd5a90fca523b33c5a78b7
2 changes: 1 addition & 1 deletion mrv2/docs/en/_sources/python_api/session.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Session module
session Module
==============

.. automodule:: mrv2.session
Expand Down
2 changes: 1 addition & 1 deletion mrv2/docs/en/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ <h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Link
<li class="toctree-l2"><a class="reference internal" href="python_api/plug-ins.html">plugin module</a></li>
<li class="toctree-l2"><a class="reference internal" href="python_api/plug-ins-system.html">Plug-in System</a></li>
<li class="toctree-l2"><a class="reference internal" href="python_api/pyFLTK.html">pyFLTK</a></li>
<li class="toctree-l2"><a class="reference internal" href="python_api/session.html">Session module</a></li>
<li class="toctree-l2"><a class="reference internal" href="python_api/session.html">session Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="python_api/settings.html">settings module</a></li>
<li class="toctree-l2"><a class="reference internal" href="python_api/timeline.html">timeline module</a></li>
<li class="toctree-l2"><a class="reference internal" href="python_api/usd.html">usd module</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/annotations.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
<li class="toctree-l2"><a class="reference internal" href="plug-ins.html">plugin module</a></li>
<li class="toctree-l2"><a class="reference internal" href="plug-ins-system.html">Plug-in System</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyFLTK.html">pyFLTK</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">Session module</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">session Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="settings.html">settings module</a></li>
<li class="toctree-l2"><a class="reference internal" href="timeline.html">timeline module</a></li>
<li class="toctree-l2"><a class="reference internal" href="usd.html">usd module</a></li>
Expand Down
2 changes: 1 addition & 1 deletion mrv2/docs/en/python_api/cmd.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
<li class="toctree-l2"><a class="reference internal" href="plug-ins.html">plugin module</a></li>
<li class="toctree-l2"><a class="reference internal" href="plug-ins-system.html">Plug-in System</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyFLTK.html">pyFLTK</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">Session module</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">session Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="settings.html">settings module</a></li>
<li class="toctree-l2"><a class="reference internal" href="timeline.html">timeline module</a></li>
<li class="toctree-l2"><a class="reference internal" href="usd.html">usd module</a></li>
Expand Down
2 changes: 1 addition & 1 deletion mrv2/docs/en/python_api/image.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@
<li class="toctree-l2"><a class="reference internal" href="plug-ins.html">plugin module</a></li>
<li class="toctree-l2"><a class="reference internal" href="plug-ins-system.html">Plug-in System</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyFLTK.html">pyFLTK</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">Session module</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">session Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="settings.html">settings module</a></li>
<li class="toctree-l2"><a class="reference internal" href="timeline.html">timeline module</a></li>
<li class="toctree-l2"><a class="reference internal" href="usd.html">usd module</a></li>
Expand Down
4 changes: 2 additions & 2 deletions mrv2/docs/en/python_api/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
<li class="toctree-l2"><a class="reference internal" href="plug-ins.html">plugin module</a></li>
<li class="toctree-l2"><a class="reference internal" href="plug-ins-system.html">Plug-in System</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyFLTK.html">pyFLTK</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">Session module</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">session Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="settings.html">settings module</a></li>
<li class="toctree-l2"><a class="reference internal" href="timeline.html">timeline module</a></li>
<li class="toctree-l2"><a class="reference internal" href="usd.html">usd module</a></li>
Expand Down Expand Up @@ -222,7 +222,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pyFLTK.html">pyFLTK</a></li>
<li class="toctree-l1"><a class="reference internal" href="session.html">Session module</a><ul>
<li class="toctree-l1"><a class="reference internal" href="session.html">session Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="session.html#mrv2.session.clearMetadata"><code class="docutils literal notranslate"><span class="pre">clearMetadata()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html#mrv2.session.current"><code class="docutils literal notranslate"><span class="pre">current()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html#mrv2.session.load"><code class="docutils literal notranslate"><span class="pre">load()</span></code></a></li>
Expand Down
2 changes: 1 addition & 1 deletion mrv2/docs/en/python_api/io.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
<li class="toctree-l2"><a class="reference internal" href="plug-ins.html">plugin module</a></li>
<li class="toctree-l2"><a class="reference internal" href="plug-ins-system.html">Plug-in System</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyFLTK.html">pyFLTK</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">Session module</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">session Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="settings.html">settings module</a></li>
<li class="toctree-l2"><a class="reference internal" href="timeline.html">timeline module</a></li>
<li class="toctree-l2"><a class="reference internal" href="usd.html">usd module</a></li>
Expand Down
2 changes: 1 addition & 1 deletion mrv2/docs/en/python_api/math.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@
<li class="toctree-l2"><a class="reference internal" href="plug-ins.html">plugin module</a></li>
<li class="toctree-l2"><a class="reference internal" href="plug-ins-system.html">Plug-in System</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyFLTK.html">pyFLTK</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">Session module</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">session Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="settings.html">settings module</a></li>
<li class="toctree-l2"><a class="reference internal" href="timeline.html">timeline module</a></li>
<li class="toctree-l2"><a class="reference internal" href="usd.html">usd module</a></li>
Expand Down
2 changes: 1 addition & 1 deletion mrv2/docs/en/python_api/media.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
<li class="toctree-l2"><a class="reference internal" href="plug-ins.html">plugin module</a></li>
<li class="toctree-l2"><a class="reference internal" href="plug-ins-system.html">Plug-in System</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyFLTK.html">pyFLTK</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">Session module</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">session Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="settings.html">settings module</a></li>
<li class="toctree-l2"><a class="reference internal" href="timeline.html">timeline module</a></li>
<li class="toctree-l2"><a class="reference internal" href="usd.html">usd module</a></li>
Expand Down
2 changes: 1 addition & 1 deletion mrv2/docs/en/python_api/mrv2.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@
<li class="toctree-l2"><a class="reference internal" href="plug-ins.html">plugin module</a></li>
<li class="toctree-l2"><a class="reference internal" href="plug-ins-system.html">Plug-in System</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyFLTK.html">pyFLTK</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">Session module</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">session Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="settings.html">settings module</a></li>
<li class="toctree-l2"><a class="reference internal" href="timeline.html">timeline module</a></li>
<li class="toctree-l2"><a class="reference internal" href="usd.html">usd module</a></li>
Expand Down
2 changes: 1 addition & 1 deletion mrv2/docs/en/python_api/playlist.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
<li class="toctree-l2"><a class="reference internal" href="plug-ins.html">plugin module</a></li>
<li class="toctree-l2"><a class="reference internal" href="plug-ins-system.html">Plug-in System</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyFLTK.html">pyFLTK</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">Session module</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">session Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="settings.html">settings module</a></li>
<li class="toctree-l2"><a class="reference internal" href="timeline.html">timeline module</a></li>
<li class="toctree-l2"><a class="reference internal" href="usd.html">usd module</a></li>
Expand Down
2 changes: 1 addition & 1 deletion mrv2/docs/en/python_api/plug-ins-system.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pyFLTK.html">pyFLTK</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">Session module</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">session Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="settings.html">settings module</a></li>
<li class="toctree-l2"><a class="reference internal" href="timeline.html">timeline module</a></li>
<li class="toctree-l2"><a class="reference internal" href="usd.html">usd module</a></li>
Expand Down
2 changes: 1 addition & 1 deletion mrv2/docs/en/python_api/plug-ins.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
</li>
<li class="toctree-l2"><a class="reference internal" href="plug-ins-system.html">Plug-in System</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyFLTK.html">pyFLTK</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">Session module</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">session Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="settings.html">settings module</a></li>
<li class="toctree-l2"><a class="reference internal" href="timeline.html">timeline module</a></li>
<li class="toctree-l2"><a class="reference internal" href="usd.html">usd module</a></li>
Expand Down
6 changes: 3 additions & 3 deletions mrv2/docs/en/python_api/pyFLTK.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Session module" href="session.html" />
<link rel="next" title="session Module" href="session.html" />
<link rel="prev" title="Plug-in System" href="plug-ins-system.html" />
</head>

Expand Down Expand Up @@ -59,7 +59,7 @@
<li class="toctree-l2"><a class="reference internal" href="plug-ins.html">plugin module</a></li>
<li class="toctree-l2"><a class="reference internal" href="plug-ins-system.html">Plug-in System</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">pyFLTK</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">Session module</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">session Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="settings.html">settings module</a></li>
<li class="toctree-l2"><a class="reference internal" href="timeline.html">timeline module</a></li>
<li class="toctree-l2"><a class="reference internal" href="usd.html">usd module</a></li>
Expand Down Expand Up @@ -112,7 +112,7 @@ <h1>pyFLTK<a class="headerlink" href="#pyfltk" title="Link to this heading"><
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="plug-ins-system.html" class="btn btn-neutral float-left" title="Plug-in System" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="session.html" class="btn btn-neutral float-right" title="Session module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="session.html" class="btn btn-neutral float-right" title="session Module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>
Expand Down
8 changes: 4 additions & 4 deletions mrv2/docs/en/python_api/session.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Session module &mdash; mrv2 v0.8.2 documentation</title>
<title>session Module &mdash; mrv2 v0.8.2 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
Expand Down Expand Up @@ -59,7 +59,7 @@
<li class="toctree-l2"><a class="reference internal" href="plug-ins.html">plugin module</a></li>
<li class="toctree-l2"><a class="reference internal" href="plug-ins-system.html">Plug-in System</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyFLTK.html">pyFLTK</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Session module</a><ul>
<li class="toctree-l2 current"><a class="current reference internal" href="#">session Module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.session.clearMetadata"><code class="docutils literal notranslate"><span class="pre">clearMetadata()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.session.current"><code class="docutils literal notranslate"><span class="pre">current()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.session.load"><code class="docutils literal notranslate"><span class="pre">load()</span></code></a></li>
Expand Down Expand Up @@ -91,7 +91,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="index.html">Python API</a></li>
<li class="breadcrumb-item active">Session module</li>
<li class="breadcrumb-item active">session Module</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/python_api/session.rst.txt" rel="nofollow"> View page source</a>
</li>
Expand All @@ -102,7 +102,7 @@
<div itemprop="articleBody">

<section id="module-mrv2.session">
<span id="session-module"></span><h1>Session module<a class="headerlink" href="#module-mrv2.session" title="Link to this heading"></a></h1>
<span id="session-module"></span><h1>session Module<a class="headerlink" href="#module-mrv2.session" title="Link to this heading"></a></h1>
<p>Session module.</p>
<p>Used to manage everything related to sessions.</p>
<dl class="py function">
Expand Down
6 changes: 3 additions & 3 deletions mrv2/docs/en/python_api/settings.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="timeline module" href="timeline.html" />
<link rel="prev" title="Session module" href="session.html" />
<link rel="prev" title="session Module" href="session.html" />
</head>

<body class="wy-body-for-nav">
Expand Down Expand Up @@ -59,7 +59,7 @@
<li class="toctree-l2"><a class="reference internal" href="plug-ins.html">plugin module</a></li>
<li class="toctree-l2"><a class="reference internal" href="plug-ins-system.html">Plug-in System</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyFLTK.html">pyFLTK</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">Session module</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">session Module</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">settings module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.settings.memory"><code class="docutils literal notranslate"><span class="pre">memory()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.settings.readAhead"><code class="docutils literal notranslate"><span class="pre">readAhead()</span></code></a></li>
Expand Down Expand Up @@ -146,7 +146,7 @@
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="session.html" class="btn btn-neutral float-left" title="Session module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="session.html" class="btn btn-neutral float-left" title="session Module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="timeline.html" class="btn btn-neutral float-right" title="timeline module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

Expand Down
2 changes: 1 addition & 1 deletion mrv2/docs/en/python_api/timeline.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
<li class="toctree-l2"><a class="reference internal" href="plug-ins.html">plugin module</a></li>
<li class="toctree-l2"><a class="reference internal" href="plug-ins-system.html">Plug-in System</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyFLTK.html">pyFLTK</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">Session module</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">session Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="settings.html">settings module</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">timeline module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.timeline.FileSequenceAudio"><code class="docutils literal notranslate"><span class="pre">FileSequenceAudio</span></code></a><ul>
Expand Down
2 changes: 1 addition & 1 deletion mrv2/docs/en/python_api/usd.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
<li class="toctree-l2"><a class="reference internal" href="plug-ins.html">plugin module</a></li>
<li class="toctree-l2"><a class="reference internal" href="plug-ins-system.html">Plug-in System</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyFLTK.html">pyFLTK</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">Session module</a></li>
<li class="toctree-l2"><a class="reference internal" href="session.html">session Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="settings.html">settings module</a></li>
<li class="toctree-l2"><a class="reference internal" href="timeline.html">timeline module</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">usd module</a><ul>
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/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 101fad38d0252a401dbdcd26cab017e7
config: d306f58b275e6cfb20954cf930d23a19
tags: 645f666f9bcd5a90fca523b33c5a78b7
4 changes: 2 additions & 2 deletions mrv2/docs/es/_sources/python_api/session.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Módulo de Sesión
================
Módulo session
==============

.. automodule:: mrv2.session
:members:
Loading

0 comments on commit 4d14092

Please sign in to comment.