Mercurial > hg > auditok
annotate doc/index.rst @ 455:7dae98b84cdd tip master
Merge branch 'master' of https://github.com/amsehili/auditok
| author | www-data <www-data@c4dm-xenserv-virt2.eecs.qmul.ac.uk> |
|---|---|
| date | Tue, 03 Dec 2024 09:18:01 +0000 |
| parents | c991dfbd5bc1 |
| children |
| 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@446 | 8 .. image:: https://codecov.io/github/amsehili/auditok/graph/badge.svg?token=0rwAqYBdkf |
| amine@446 | 9 :target: https://codecov.io/github/amsehili/auditok |
| amine@446 | 10 |
| amine@37 | 11 .. image:: https://readthedocs.org/projects/auditok/badge/?version=latest |
| amine@38 | 12 :target: http://auditok.readthedocs.org/en/latest/?badge=latest |
| amine@38 | 13 :alt: Documentation Status |
| amine@32 | 14 |
| amine@32 | 15 |
| amine@32 | 16 |
| amine@437 | 17 ``auditok`` is an **Audio Activity Detection** tool that processes online data |
| amine@432 | 18 (from an audio device or standard input) and audio files. It can be used via the command line or through its API. |
| amine@432 | 19 |
| amine@432 | 20 Full documentation is available on `Read the Docs <https://auditok.readthedocs.io/en/latest/>`_. |
| amine@32 | 21 |
| amine@32 | 22 |
| amine@23 | 23 .. toctree:: |
| amine@369 | 24 :caption: Getting started |
| amine@369 | 25 :maxdepth: 3 |
| amine@23 | 26 |
| amine@369 | 27 installation |
| amine@369 | 28 examples |
| amine@35 | 29 |
| amine@35 | 30 .. toctree:: |
| amine@379 | 31 :caption: Command-line guide |
| amine@379 | 32 :maxdepth: 3 |
| amine@379 | 33 |
| amine@379 | 34 command_line_usage |
| amine@379 | 35 |
| amine@379 | 36 |
| amine@379 | 37 |
| amine@379 | 38 .. toctree:: |
| amine@369 | 39 :caption: API Reference |
| amine@35 | 40 :maxdepth: 3 |
| amine@35 | 41 |
| amine@369 | 42 core |
| amine@369 | 43 util |
| amine@369 | 44 io |
| amine@369 | 45 signal |
| amine@23 | 46 |
| amine@369 | 47 License |
| amine@369 | 48 ------- |
| amine@432 | 49 |
| amine@369 | 50 MIT. |