Mercurial > hg > auditok

view doc/index.rst @ 435:4b74e44900d2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add .readthedocs.yaml
author Amine Sehili <amine.sehili@gmail.com>
date Wed, 30 Oct 2024 22:00:59 +0100
parents 81bc2375354f
children 2644f997b6e0
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://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.