Changeset fbafd2c for doc/cli.rst

Timestamp:

Mar 25, 2017, 12:12:38 PM (7 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

sampler

Children:

b201912

Parents:

f8d96f1 (diff), 2a7bcaa (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Merge branch 'master' into sampler

File:

• doc/cli.rst (modified) (8 diffs)

doc/cli.rst

@@ -4 +4 @@
 ==================
 
-A few simple command line tools are included along with the library.
+The python module comes with the following tools:
+
+ - ``aubio`` estimate and extract descriptors from sound files
+ - ``aubiocut`` slices sound files at onset or beat timestamps
+
+More command line tools are included along with the library.
 
  - ``aubioonset`` outputs the time stamp of detected note onsets
@@ -14 +19 @@
  - ``aubioquiet`` extracts quiet and loud regions
 
-Additionally, the python module comes with the following script:
 
- - ``aubiocut`` slices sound files at onset or beat timestamps
+``aubio``
+---------
+
+.. literalinclude:: aubio.txt
+   :language: text
 
 
-.. toctree::
+``aubiocut``
+--------------
 
-   cli_features
+.. literalinclude:: aubiocut.txt
+   :language: text
 
 
@@ -28 +38 @@
 
 .. literalinclude:: aubioonset.txt
+   :language: text
 
 ``aubiopitch``
@@ -33 +44 @@
 
 .. literalinclude:: aubiopitch.txt
+   :language: text
 
 ``aubiomfcc``
@@ -38 +50 @@
 
 .. literalinclude:: aubiomfcc.txt
+   :language: text
 
 ``aubiotrack``
@@ -43 +56 @@
 
 .. literalinclude:: aubiotrack.txt
+   :language: text
 
 ``aubionotes``
@@ -48 +62 @@
 
 .. literalinclude:: aubionotes.txt
+   :language: text
 
 ``aubioquiet``
@@ -53 +68 @@
 
 .. literalinclude:: aubioquiet.txt
+   :language: text
 
-``aubiocut``
---------------
 
-.. literalinclude:: aubiocut.txt
+.. include:: cli_features.rst