.. Yuuno documentation master file, created by
   sphinx-quickstart on Fri Jan 13 19:14:31 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Yuuno
=====

Yuuno incorporates VapourSynth into Jupyter.


Installing and running
----------------------

To install Yuuno, run these two commands in your console.

.. code:: batch

   $ py -3.6 -m pip install yuuno
   $ py -3.6 -m notebook.nbextensions enable --py --sys-prefix widgetsnbextension

To run it:

.. code:: batch

   $ py -3.6 -m notebook

.. note::

   Python must be available on your PATH. If it is not installed on your path, the jupyter command will fail
   will report a missing file.

Using Yuuno
-----------

Initiating Yuuno

.. code:: python

   >>> %load_ext yuuno
   >>> %yuuno install

The module `vapoursynth` will automatically made available as the variable `vs` and the current core instance is
made available with the variable `core`.

For the rest, please refer to the `tutorial here <https://yuuno.encode.moe/tutorial.html>`_.


API Documentation
-----------------

.. toctree::
   :maxdepth: 2
   :glob:

   yuuno.rst
   yuuno.*


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
