Skip to content

Commit

Permalink
Updated documentation.
Browse files Browse the repository at this point in the history
Made building documentation automatically when doing a release.
  • Loading branch information
ggarra13 committed May 21, 2024
1 parent b5c7043 commit 9fe7f27
Show file tree
Hide file tree
Showing 85 changed files with 502 additions and 502 deletions.
6 changes: 3 additions & 3 deletions docs/sphinx/en/user_docs/getting_started/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,17 @@ Installing mrv2

On Debian (Ubuntu, etc) systems, you would install with::

sudo dpkg -i mrv2-v1.1.6-amd64.tar.gz
sudo dpkg -i mrv2-v1.1.8-amd64.tar.gz
On Red Hat (Rocky Linux, etc), you would install it with::

sudo rpm -i mrv2-v1.1.6-amd64.tar.gz
sudo rpm -i mrv2-v1.1.8-amd64.tar.gz

Once you install it, you can run mrv2 by just typing mrv2 in the shell, as a symlink to the executable is placed in /usr/bin. The installers will also associate file extensions and install an icon for easy starting up in the Desktop icon of the user that installed it. For running mrv2 with the icon, you need to select it and use the right mouse button to open the menu and choose Allow Launch.

If you lack sudo permissions in your organization, you should download the .tar.gz file and you can uncompress it with::

tar -xf mrv2-v1.1.6-amd64.tar.gz
tar -xf mrv2-v1.1.8-amd64.tar.gz
That will create a folder in the direcory you uncompress it from. You can then run mrv2 by using the bash script::

Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx/en/user_docs/interface/interface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ The Timeline menu provides controls for modifying the timeline viewport at the b
.. topic:: Transitions

With this on, you can show audio and video transitions in .otio files.
(Currently not implemented in v1.1.6).
(Currently not implemented in v1.1.8).

.. topic:: Markers

Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx/en/user_docs/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ mrv2 is an open source professional flipbook and review tool for the Visual Effe
mrv2 can handle collections of media sources quickly, loads specialised image formats and displays images with colour management. Users can quickly import, organise and group media into playlists and 'subsets', playing through and looping on media items and adding review notes and sketched annotations, allowing one to view the media in a highly interactive and collaborative way. This enables workflows that are essential for teams in VFX, animation and other post-production activities who need to see, on demand, the artwork that they and their colleagues are creating. For example one can jump between the viewed media source instantaneously, inspect pixels close-up, do frame-by-frame comparisons across multiple media sources, annotate the media with drawings and captions or add feedback notes to share.


Current Version: v1.1.6 - Overview
Current Version: v1.1.8 - Overview
**********************************

This version of the application is a robust and high performance playback and review solution. mrv2 has been deployed at multiple facilities and is used by multiple individuals daily since August 2022.
Expand Down
6 changes: 3 additions & 3 deletions docs/sphinx/es/user_docs/getting_started/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ Instalando mrv2

En Debian (Ubuntu, etc), lo instalaría con::

sudo dpkg -i mrv2-v1.1.6-amd64.tar.gz
sudo dpkg -i mrv2-v1.1.8-amd64.tar.gz
En Red Hat (Rocky Linux, etc), lo instalaría con::

sudo rpm -i mrv2-v1.1.6-amd64.tar.gz
sudo rpm -i mrv2-v1.1.8-amd64.tar.gz

Una vez que lo instala, puede correr mrv2 tipeando::

Expand All @@ -40,7 +40,7 @@ Para correr mrv2 con el ícono, necesita seleccionarlo y usar el botón derecho

Si no tiene permisos de super usuario en su organización, debería bajar el archivo .tar.gz y descomprimirlo con::

tar -xf mrv2-v1.1.6-amd64.tar.gz
tar -xf mrv2-v1.1.8-amd64.tar.gz
Eso creará una carpeta en el directorio desde donde lo descomprimió. Podrá correr mrv2 usando el script de bash::

Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx/es/user_docs/interface/interface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ El menú de línea de tiempo provee controles para modificar la ventana gráfica

Con esto prendido, podés mostrar las transiciones de audio y vídeo en
archivos .otio.
(Actualmente no implementado en v1.1.6).
(Actualmente no implementado en v1.1.8).

.. topic:: Marcadores

Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx/es/user_docs/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ mrv2 es un flipbook profesional y herramienta de revisión de código abierto pa
mrv2 puede manejar colecciones de medios rápidamente, carga una multitud de formatos de imagen y video especializados y muestra la imágenes con manejo de color. Los usuarios pueden importar, organizar y agrupar medios en listas de reproducción de OTIO, reproduciendo items y agregando notas de revisiones y anotaciones dibujadas, permitiendo visualizar el contenido en forma interactiva y colaborativa. Esto permite el flujo que es esencial para los equipos de efectos visuales, animación y otras actividades de post-production que necesitan ver, en demanda, el arte que ellos y sus colegas están creando. Por ejemplo, uno puede cambiar de fuente de medios instantáneamente, inspeccionar pixels de cerca, hacer comparaciones cuadro a cuadro a través de multiple fuentes de medios, anotar los medios con dibujos y texto o agregar notas para compartir con otros.


Versión Actual: v1.1.6 - Descripción General
Versión Actual: v1.1.8 - Descripción General
********************************************

Esta versión de la aplicación es una solución de revisión sólida y robusta. mrv2 ha sido desplegado en múltiples estudios y es usado por múltiples individuos diariamente desde Augosto del 2022.
Expand Down
2 changes: 1 addition & 1 deletion mrv2/docs/en/.buildinfo
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: 76a07f8fd3b127b688ba3e21ee552582
config: 06c5e3cf4233c6b8f6777fc8535fdfc9
tags: 645f666f9bcd5a90fca523b33c5a78b7
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,17 @@ Installing mrv2

On Debian (Ubuntu, etc) systems, you would install with::

sudo dpkg -i mrv2-v1.1.6-amd64.tar.gz
sudo dpkg -i mrv2-v1.1.8-amd64.tar.gz
On Red Hat (Rocky Linux, etc), you would install it with::

sudo rpm -i mrv2-v1.1.6-amd64.tar.gz
sudo rpm -i mrv2-v1.1.8-amd64.tar.gz

Once you install it, you can run mrv2 by just typing mrv2 in the shell, as a symlink to the executable is placed in /usr/bin. The installers will also associate file extensions and install an icon for easy starting up in the Desktop icon of the user that installed it. For running mrv2 with the icon, you need to select it and use the right mouse button to open the menu and choose Allow Launch.

If you lack sudo permissions in your organization, you should download the .tar.gz file and you can uncompress it with::

tar -xf mrv2-v1.1.6-amd64.tar.gz
tar -xf mrv2-v1.1.8-amd64.tar.gz
That will create a folder in the direcory you uncompress it from. You can then run mrv2 by using the bash script::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ The Timeline menu provides controls for modifying the timeline viewport at the b
.. topic:: Transitions

With this on, you can show audio and video transitions in .otio files.
(Currently not implemented in v1.1.6).
(Currently not implemented in v1.1.8).

.. topic:: Markers

Expand Down
2 changes: 1 addition & 1 deletion mrv2/docs/en/_sources/user_docs/overview.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ mrv2 is an open source professional flipbook and review tool for the Visual Effe
mrv2 can handle collections of media sources quickly, loads specialised image formats and displays images with colour management. Users can quickly import, organise and group media into playlists and 'subsets', playing through and looping on media items and adding review notes and sketched annotations, allowing one to view the media in a highly interactive and collaborative way. This enables workflows that are essential for teams in VFX, animation and other post-production activities who need to see, on demand, the artwork that they and their colleagues are creating. For example one can jump between the viewed media source instantaneously, inspect pixels close-up, do frame-by-frame comparisons across multiple media sources, annotate the media with drawings and captions or add feedback notes to share.


Current Version: v1.1.6 - Overview
Current Version: v1.1.8 - Overview
**********************************

This version of the application is a robust and high performance playback and review solution. mrv2 has been deployed at multiple facilities and is used by multiple individuals daily since August 2022.
Expand Down
2 changes: 1 addition & 1 deletion mrv2/docs/en/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: 'v1.1.7',
VERSION: 'v1.1.8',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
4 changes: 2 additions & 2 deletions mrv2/docs/en/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &mdash; mrv2 v1.1.7 documentation</title>
<title>Index &mdash; mrv2 v1.1.8 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=fd3f3429" />
Expand All @@ -15,7 +15,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=ccbe0283"></script>
<script src="_static/documentation_options.js?v=24a4a141"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions mrv2/docs/en/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Welcome to mrv2’s documentation! &mdash; mrv2 v1.1.7 documentation</title>
<title>Welcome to mrv2’s documentation! &mdash; mrv2 v1.1.8 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=fd3f3429" />
Expand All @@ -16,7 +16,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=ccbe0283"></script>
<script src="_static/documentation_options.js?v=24a4a141"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions mrv2/docs/en/py-modindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -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 v1.1.7 documentation</title>
<title>Python Module Index &mdash; mrv2 v1.1.8 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=fd3f3429" />
Expand All @@ -15,7 +15,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=ccbe0283"></script>
<script src="_static/documentation_options.js?v=24a4a141"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions mrv2/docs/en/python_api/annotations.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>annotations module &mdash; mrv2 v1.1.7 documentation</title>
<title>annotations module &mdash; mrv2 v1.1.8 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=fd3f3429" />
Expand All @@ -16,7 +16,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=ccbe0283"></script>
<script src="../_static/documentation_options.js?v=24a4a141"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions mrv2/docs/en/python_api/cmd.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cmd module &mdash; mrv2 v1.1.7 documentation</title>
<title>cmd module &mdash; mrv2 v1.1.8 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=fd3f3429" />
Expand All @@ -16,7 +16,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=ccbe0283"></script>
<script src="../_static/documentation_options.js?v=24a4a141"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions mrv2/docs/en/python_api/image.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>image module &mdash; mrv2 v1.1.7 documentation</title>
<title>image module &mdash; mrv2 v1.1.8 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=fd3f3429" />
Expand All @@ -16,7 +16,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=ccbe0283"></script>
<script src="../_static/documentation_options.js?v=24a4a141"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions mrv2/docs/en/python_api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Python API &mdash; mrv2 v1.1.7 documentation</title>
<title>Python API &mdash; mrv2 v1.1.8 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=fd3f3429" />
Expand All @@ -16,7 +16,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=ccbe0283"></script>
<script src="../_static/documentation_options.js?v=24a4a141"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions mrv2/docs/en/python_api/io.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>io Module &mdash; mrv2 v1.1.7 documentation</title>
<title>io Module &mdash; mrv2 v1.1.8 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=fd3f3429" />
Expand All @@ -16,7 +16,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=ccbe0283"></script>
<script src="../_static/documentation_options.js?v=24a4a141"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions mrv2/docs/en/python_api/math.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>math module &mdash; mrv2 v1.1.7 documentation</title>
<title>math module &mdash; mrv2 v1.1.8 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=fd3f3429" />
Expand All @@ -16,7 +16,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=ccbe0283"></script>
<script src="../_static/documentation_options.js?v=24a4a141"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions mrv2/docs/en/python_api/media.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>media module &mdash; mrv2 v1.1.7 documentation</title>
<title>media module &mdash; mrv2 v1.1.8 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=fd3f3429" />
Expand All @@ -16,7 +16,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=ccbe0283"></script>
<script src="../_static/documentation_options.js?v=24a4a141"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
Expand Down
Loading

0 comments on commit 9fe7f27

Please sign in to comment.