.. Natron documentation master file, created by
   sphinx-quickstart on Tue Mar 29 18:02:16 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.
.. for help on writing/extending this file, see the reStructuredText cheatsheet
   http://github.com/ralsina/rst-cheatsheet/raw/master/rst-cheatsheet.pdf

Natron documentation
====================

The Natron documentation is organized as follows:

- The :ref:`user-guide` contains everything to get started with Natron, including tutorials.
- The :ref:`reference-guide` contains the documentation about the user settings and environment variables for Natron, as well as the documentation for each node in Natron.
- The :ref:`developers-guide` contains documentation about using the Python scripting language within Natron, and using the Natron command-line interface (a.k.a. NatronRenderer).
- The :ref:`maintainers-guide` contains documentation for developers who want to contribute to Natron's own C++ source code: the global code design, the techniques used, the different modules and their function, a technical TODO list (including the Qt 6 migration plan), and a triage of the open issues.

This documentation is also
`available online <http://natron.readthedocs.io/en/rb-2.6/>`_
and can be downloaded as a
`PDF <https://readthedocs.org/projects/natron/downloads/pdf/rb-2.6/>`_,
`HTML zip <https://readthedocs.org/projects/natron/downloads/htmlzip/rb-2.6/>`_
or
`ePub <https://readthedocs.org/projects/natron/downloads/epub/rb-2.6/>`_
file.

This manual is maintained largely by volunteers.

The `Creative Commons Attribution-ShareAlike 4.0 International License (CC-BY-SA 4.0) <https://creativecommons.org/licenses/by-sa/4.0/>`_ is used for this manual, which is a free and open license. Though there are certain restrictions that come with this license you may in general freely reproduce it and even make changes to it. However, rather than distribute your own version of this manual, we would much prefer if you would send any corrections or changes to the Natron project.

The *Natron documentation authors* are:

- Alexandre Gauthier-Foichat
- Ole-André Rodlie <rodlie@github>
- Omar Brown
- Frédéric Devernay <devernay@github>
- Alexandre Bon <bonalex01dev@github>
- <hellocatfood@github>
- Marc-André Gasser <magdesign@github>
- Huân Lê-Vương <lehuan5062@github>
- Fahad Hasan Pathik <cgvirus@github>

.. toctree::
    :maxdepth: 3

    guide/index.rst
    _group.rst
    devel/index.rst
    maintainers/index.rst