Updated docs.

ggarra13 · Oct 9, 2023 · ce3647d · ce3647d
1 parent 34bfd32
commit ce3647d
Show file tree

Hide file tree

Showing 76 changed files with 444 additions and 353 deletions.
diff --git a/mrv2/docs/HISTORY.md b/mrv2/docs/HISTORY.md
@@ -4,6 +4,10 @@ v0.8.0
 - Fixed mrv2's file requester not selecting files with [] in them.
 - Fixed mrv2's file requester not changing directories if you had typed the
   full name of the directory in the filename field and pressed Enter,
+- Fixed a crash when loading a session with no files.
+- Added session name to the window's title bar.
+- Fixed a typo in Python's binding to sessios (oepenSession instead of
+  openSession).
 
 v0.7.9
 ======

diff --git a/mrv2/docs/en/.buildinfo b/mrv2/docs/en/.buildinfo
@@ -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: 09a18046b99087f44fea6ffec12e384f
+config: 1879dc6ceb212ab6305bc2af28a917ac
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/mrv2/docs/en/_modules/index.html b/mrv2/docs/en/_modules/index.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Overview: module code &mdash; mrv2 v0.7.9 documentation</title>
+  <title>Overview: module code &mdash; mrv2 v0.8.0 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" />
@@ -13,7 +13,7 @@
 
         <script src="../_static/jquery.js?v=5d32c60e"></script>
         <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../_static/documentation_options.js?v=8222a189"></script>
+        <script src="../_static/documentation_options.js?v=b3dab91b"></script>
         <script src="../_static/doctools.js?v=888ff710"></script>
         <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>

diff --git a/mrv2/docs/en/_static/documentation_options.js b/mrv2/docs/en/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: 'v0.7.9',
+    VERSION: 'v0.8.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/mrv2/docs/en/genindex.html b/mrv2/docs/en/genindex.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Index &mdash; mrv2 v0.7.9 documentation</title>
+  <title>Index &mdash; mrv2 v0.8.0 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" />
@@ -13,7 +13,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=8222a189"></script>
+        <script src="_static/documentation_options.js?v=b3dab91b"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
@@ -176,10 +176,10 @@ <h2 id="C">C</h2>
       </ul></li>
       <li><a href="python_api/image.html#mrv2.image.Color">Color (class in mrv2.image)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="python_api/image.html#mrv2.image.DisplayOptions.color">color (mrv2.image.DisplayOptions attribute)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="python_api/cmd.html#mrv2.cmd.compare">compare() (in module mrv2.cmd)</a>
 </li>
       <li><a href="python_api/media.html#mrv2.media.CompareMode">CompareMode (class in mrv2.media)</a>
@@ -195,6 +195,8 @@ <h2 id="C">C</h2>
       <li><a href="python_api/mrv2.html#mrv2.TimeRange.contains">contains() (mrv2.TimeRange method)</a>
 </li>
       <li><a href="python_api/image.html#mrv2.image.Color.contrast">contrast (mrv2.image.Color attribute)</a>
+</li>
+      <li><a href="python_api/cmd.html#mrv2.cmd.currentSession">currentSession() (in module mrv2.cmd)</a>
 </li>
       <li><a href="python_api/mrv2.html#mrv2.FileMedia.currentTime">currentTime (mrv2.FileMedia attribute)</a>
 </li>
@@ -567,9 +569,9 @@ <h2 id="N">N</h2>
 <h2 id="O">O</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="python_api/cmd.html#mrv2.cmd.oepnSession">oepnSession() (in module mrv2.cmd)</a>
-</li>
       <li><a href="python_api/cmd.html#mrv2.cmd.open">open() (in module mrv2.cmd)</a>
+</li>
+      <li><a href="python_api/cmd.html#mrv2.cmd.openSession">openSession() (in module mrv2.cmd)</a>
 </li>
       <li><a href="python_api/image.html#mrv2.image.LUTOptions.order">order (mrv2.image.LUTOptions attribute)</a>
 </li>
@@ -678,6 +680,8 @@ <h2 id="S">S</h2>
       <li><a href="python_api/media.html#mrv2.media.setB">setB() (in module mrv2.media)</a>
 </li>
       <li><a href="python_api/cmd.html#mrv2.cmd.setCompareOptions">setCompareOptions() (in module mrv2.cmd)</a>
+</li>
+      <li><a href="python_api/cmd.html#mrv2.cmd.setCurrentSession">setCurrentSession() (in module mrv2.cmd)</a>
 </li>
       <li><a href="python_api/cmd.html#mrv2.cmd.setDisplayOptions">setDisplayOptions() (in module mrv2.cmd)</a>
 </li>
@@ -692,11 +696,11 @@ <h2 id="S">S</h2>
       <li><a href="python_api/media.html#mrv2.media.setLayer">setLayer() (in module mrv2.media)</a>
 </li>
       <li><a href="python_api/timeline.html#mrv2.timeline.setLoop">setLoop() (in module mrv2.timeline)</a>
-</li>
-      <li><a href="python_api/cmd.html#mrv2.cmd.setLUTOptions">setLUTOptions() (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.setLUTOptions">setLUTOptions() (in module mrv2.cmd)</a>
+</li>
       <li><a href="python_api/settings.html#mrv2.settings.setMemory">setMemory() (in module mrv2.settings)</a>
 </li>
       <li><a href="python_api/cmd.html#mrv2.cmd.setMute">setMute() (in module mrv2.cmd)</a>

diff --git a/mrv2/docs/en/index.html b/mrv2/docs/en/index.html
@@ -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>Welcome to mrv2’s documentation! &mdash; mrv2 v0.7.9 documentation</title>
+  <title>Welcome to mrv2’s documentation! &mdash; mrv2 v0.8.0 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" />
@@ -14,7 +14,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=8222a189"></script>
+        <script src="_static/documentation_options.js?v=b3dab91b"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>

diff --git a/mrv2/docs/en/objects.inv b/mrv2/docs/en/objects.inv
diff --git a/mrv2/docs/en/py-modindex.html b/mrv2/docs/en/py-modindex.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Python Module Index &mdash; mrv2 v0.7.9 documentation</title>
+  <title>Python Module Index &mdash; mrv2 v0.8.0 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" />
@@ -13,7 +13,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=8222a189"></script>
+        <script src="_static/documentation_options.js?v=b3dab91b"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>

diff --git a/mrv2/docs/en/python_api/annotations.html b/mrv2/docs/en/python_api/annotations.html
@@ -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>annotations module &mdash; mrv2 v0.7.9 documentation</title>
+  <title>annotations module &mdash; mrv2 v0.8.0 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" />
@@ -14,7 +14,7 @@
 
         <script src="../_static/jquery.js?v=5d32c60e"></script>
         <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../_static/documentation_options.js?v=8222a189"></script>
+        <script src="../_static/documentation_options.js?v=b3dab91b"></script>
         <script src="../_static/doctools.js?v=888ff710"></script>
         <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>