Mercurial > hg > auditok

annotate doc/index.rst @ 429:97eff033c8f8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update README
author Amine Sehili <amine.sehili@gmail.com>
date Wed, 30 Oct 2024 11:17:38 +0100
parents df2a320e10d5
children 81bc2375354f
rev   line source
amine@377 1 auditok, an AUDIo TOKenization tool
amine@377 2 ===================================
amine@23 3
amine@32 4 .. image:: https://travis-ci.org/amsehili/auditok.svg?branch=master
amine@32 5 :target: https://travis-ci.org/amsehili/auditok
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@377 14 ``auditok`` is an **Audio Activity Detection** tool that can process online data
amine@369 15 (read from an audio device or from standard input) as well as audio files. It
amine@369 16 can be used as a command line program or by calling its API.
amine@32 17
amine@32 18
amine@23 19 .. toctree::
amine@369 20 :caption: Getting started
amine@369 21 :maxdepth: 3
amine@23 22
amine@369 23 installation
amine@369 24 examples
amine@35 25
amine@35 26 .. toctree::
amine@379 27 :caption: Command-line guide
amine@379 28 :maxdepth: 3
amine@379 29
amine@379 30 command_line_usage
amine@379 31
amine@379 32
amine@379 33
amine@379 34 .. toctree::
amine@369 35 :caption: API Reference
amine@35 36 :maxdepth: 3
amine@35 37
amine@369 38 core
amine@369 39 util
amine@369 40 io
amine@369 41 signal
amine@369 42 dataset
amine@23 43
amine@369 44 License
amine@369 45 -------
amine@369 46 MIT.