view doc/index.rst @ 369:0106c4799906

Update documentation
author Amine Sehili <amine.sehili@gmail.com>
date Sun, 10 Jan 2021 22:36:22 +0100
parents 9741b52f194a
children c6308873f239
line wrap: on
line source

.. autosummary::
    :toctree: generated/



.. image:: https://travis-ci.org/amsehili/auditok.svg?branch=master
    :target: https://travis-ci.org/amsehili/auditok

.. image:: https://readthedocs.org/projects/auditok/badge/?version=latest
    :target: http://auditok.readthedocs.org/en/latest/?badge=latest
    :alt: Documentation Status



`auditok` is an **Audio Activity Detection** tool that can process online data
(read from an audio device or from standard input) as well as audio files. It
can be used as a command line program or by calling its API.


.. toctree::
    :caption: Getting started
    :maxdepth: 3

    installation
    examples

.. toctree::
    :caption: API Reference
    :maxdepth: 3

    core
    util
    io
    signal
    dataset

License
-------
MIT.