Mercurial > hg > auditok

annotate doc/index.rst @ 444:dde9d076e6ee

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add codecov
author Amine Sehili <amine.sehili@gmail.com>
date Thu, 31 Oct 2024 09:24:40 +0100
parents 2644f997b6e0
children c991dfbd5bc1
rev   line source
amine@377 1 auditok, an AUDIo TOKenization tool
amine@377 2 ===================================
amine@23 3
amine@432 4 .. image:: https://github.com/amsehili/auditok/actions/workflows/ci.yml/badge.svg
amine@432 5 :target: https://github.com/amsehili/auditok/actions/workflows/ci.yml/
amine@377 6 :alt: Build Status
amine@331 7
amine@37 8 .. image:: https://readthedocs.org/projects/auditok/badge/?version=latest
amine@38 9 :target: http://auditok.readthedocs.org/en/latest/?badge=latest
amine@38 10 :alt: Documentation Status
amine@32 11
amine@32 12
amine@32 13
amine@437 14 ``auditok`` is an **Audio Activity Detection** tool that processes online data
amine@432 15 (from an audio device or standard input) and audio files. It can be used via the command line or through its API.
amine@432 16
amine@432 17 Full documentation is available on `Read the Docs <https://auditok.readthedocs.io/en/latest/>`_.
amine@32 18
amine@32 19
amine@23 20 .. toctree::
amine@369 21 :caption: Getting started
amine@369 22 :maxdepth: 3
amine@23 23
amine@369 24 installation
amine@369 25 examples
amine@35 26
amine@35 27 .. toctree::
amine@379 28 :caption: Command-line guide
amine@379 29 :maxdepth: 3
amine@379 30
amine@379 31 command_line_usage
amine@379 32
amine@379 33
amine@379 34
amine@379 35 .. toctree::
amine@369 36 :caption: API Reference
amine@35 37 :maxdepth: 3
amine@35 38
amine@369 39 core
amine@369 40 util
amine@369 41 io
amine@369 42 signal
amine@23 43
amine@369 44 License
amine@369 45 -------
amine@432 46
amine@369 47 MIT.