Reference Guide
===============

Class Inheritance Diagram
-------------------------

.. inheritance-diagram:: ftpsync.targets ftpsync.ftp_target ftpsync.sftp_target ftpsync.resources ftpsync.synchronizers ftpsync.metadata ftpsync.util
   :parts: 2
   :private-bases:
   :caption: pyftpsync classes


Algorithm
---------

..
    See `pyftpsync-spec.pdf <https://raw.githubusercontent.com/mar10/pyftpsync/master/docs/pyftpsync-spec.pdf>`_
    for some explanations.
    See also the `Pyftpsync specification <_downloads/pyftpsync-spec.pdf>`_
    (:download:`download <_static/pyftpsync-spec.pdf>`)

    NOTE: we need a :download: reference, otherwise the file will not be
    copied to dist folder

.. seealso::
   See also the `pyftpsync-spec.pdf <_static/pyftpsync-spec.pdf>`_
   for details about the algorithm and implementation.


API Reference
-------------

.. toctree::
   :maxdepth: 4

   modules
   genindex


.. genindex fails when an epub is created with Sphinx 1.5
   Sphinx 1.6 is not yet supported by RTD
   genindex