.. subliminal documentation master file, created by
   sphinx-quickstart on Sat Jul 11 00:40:28 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to subliminal!
======================
Subliminal is a python3 library to search and download subtitles.
It comes with an easy to use yet powerful :abbr:`CLI (command-line interface)` suitable for direct use or cron jobs.


Documentation
-------------
.. toctree::
    :maxdepth: 2

    user/usage
    user/installation
    user/how_it_works
    user/cli
    user/configuration_file
    user/provider_guide

.. toctree::
   :maxdepth: 1

   user/changelog


API Documentation
-----------------
If you are looking for information on a specific function, class or method, this part of the documentation is for you.

.. toctree::
    :caption: API
    :maxdepth: 1

    api/core
    api/video
    api/subtitle
    api/providers
    api/refiners
    api/extensions
    api/score
    api/utils
    api/cache
    api/cli
    api/exceptions


License
-------
MIT


Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
