Mercurial > hg > auditok
annotate doc/index.rst @ 374:2e26a7c5f300
Update Readme
| author | Amine Sehili <amine.sehili@gmail.com> |
|---|---|
| date | Thu, 21 Jan 2021 22:19:47 +0100 |
| parents | 0106c4799906 |
| children | c6308873f239 |
| rev | line source |
|---|---|
| amine@369 | 1 |
| amine@369 | 2 .. autosummary:: |
| amine@369 | 3 :toctree: generated/ |
| amine@369 | 4 |
| amine@369 | 5 |
| amine@23 | 6 |
| amine@32 | 7 .. image:: https://travis-ci.org/amsehili/auditok.svg?branch=master |
| amine@32 | 8 :target: https://travis-ci.org/amsehili/auditok |
| amine@331 | 9 |
| amine@37 | 10 .. image:: https://readthedocs.org/projects/auditok/badge/?version=latest |
| amine@38 | 11 :target: http://auditok.readthedocs.org/en/latest/?badge=latest |
| amine@38 | 12 :alt: Documentation Status |
| amine@32 | 13 |
| amine@32 | 14 |
| amine@32 | 15 |
| amine@369 | 16 `auditok` is an **Audio Activity Detection** tool that can process online data |
| amine@369 | 17 (read from an audio device or from standard input) as well as audio files. It |
| amine@369 | 18 can be used as a command line program or by calling its API. |
| amine@32 | 19 |
| amine@32 | 20 |
| amine@23 | 21 .. toctree:: |
| amine@369 | 22 :caption: Getting started |
| amine@369 | 23 :maxdepth: 3 |
| amine@23 | 24 |
| amine@369 | 25 installation |
| amine@369 | 26 examples |
| amine@35 | 27 |
| amine@35 | 28 .. toctree:: |
| amine@369 | 29 :caption: API Reference |
| amine@35 | 30 :maxdepth: 3 |
| amine@35 | 31 |
| amine@369 | 32 core |
| amine@369 | 33 util |
| amine@369 | 34 io |
| amine@369 | 35 signal |
| amine@369 | 36 dataset |
| amine@23 | 37 |
| amine@369 | 38 License |
| amine@369 | 39 ------- |
| amine@369 | 40 MIT. |