view doc/index.rst @ 447:2f59d326cc0d

Update CHANGELOG
author Amine Sehili <amine.sehili@gmail.com>
date Thu, 31 Oct 2024 10:02:21 +0100
parents c991dfbd5bc1
children
line wrap: on
line source
auditok, an AUDIo TOKenization tool
===================================

.. image:: https://github.com/amsehili/auditok/actions/workflows/ci.yml/badge.svg
    :target: https://github.com/amsehili/auditok/actions/workflows/ci.yml/
    :alt: Build Status

.. image:: https://codecov.io/github/amsehili/auditok/graph/badge.svg?token=0rwAqYBdkf
 :target: https://codecov.io/github/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 processes online data
(from an audio device or standard input) and audio files. It can be used via the command line or through its API.

Full documentation is available on `Read the Docs <https://auditok.readthedocs.io/en/latest/>`_.


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

    installation
    examples

.. toctree::
    :caption: Command-line guide
    :maxdepth: 3

    command_line_usage



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

    core
    util
    io
    signal

License
-------

MIT.