Skip to content

Commit

Permalink
Document %runvpy and better %preview doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
stuxcrystal committed Jul 24, 2017
1 parent 52b2e7d commit eaa2a71
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/howtos/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ things in Yuuno.
:maxdepth: 2

reuse_preview
run_vpy
auto_import_yuuno
configure_yuuno
11 changes: 11 additions & 0 deletions docs/howtos/reuse_preview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,17 @@ Step by step

This should show a simple preview widget without an image.

.. important::

Make sure this code is run in its own cell as Yuuno will only save the frame when switching the clip
of the preview instance.

.. note::

On older IPython versions you might need to import `display` manually. Do so using::

from IPython.display import display

2. Assign a clip to the preview-widget::

my_preview.clip = core.std.BlankClip(color=[0,0,255])
Expand Down
17 changes: 17 additions & 0 deletions docs/howtos/run_vpy.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
=================================
Run vapoursynth scripts via Yuuno
=================================

You can run vapoursynth scripts (.vpy) using the line magic `%runvpy` with takes a path as an argument.

It will return a dictionary with all outputs defined by the vpy-file so you can use it
to encode or further modify the clip.

Simple example:
---------------

Here is a simple example::

%runvpy test.vpy

Upon successful execution it will return a dictionary with your outputs.

0 comments on commit eaa2a71

Please sign in to comment.