Changeset f8bf0c2 for doc


Ignore:
Timestamp:
Oct 31, 2018, 4:25:09 PM (6 years ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master
Children:
f214e9c
Parents:
68daf5b
Message:

[doc] reorganize python doc

Location:
doc
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • doc/python.rst

    r68daf5b rf8bf0c2  
    88   we follow numpy type docstrings, see:
    99   https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard
     10..
     11   note: we do not import aubio's docstring, which will be displayed from an
     12   interpreter.
     13
     14.. .. automodule:: aubio
     15
    1016
    1117.. _python:
    … …  
    1420====================
    1521
     22This module provides a number of classes and functions for the analysis of
     23music and audio signals.
    1624
    17 .. midiconv.py
     25Contents
     26--------
    1827
    19 .. autofunction:: note2midi
     28.. toctree::
     29   :maxdepth: 1
    2030
    21 .. autofunction:: midi2note
     31   py_examples
     32   py_datatypes
     33   py_io
     34   py_utils
    2235
    23 .. autofunction:: freq2note
     36Introduction
     37------------
    2438
    25 .. autofunction:: note2freq
     39This document provides a reference guide. For documentation on how to
     40install aubio, see :ref:`python-install`.
    2641
    27 .. slicing.py
     42Examples included in this guide and within the code are written assuming
     43both `aubio` and `numpy`_ have been imported:
    2844
    29 .. autofunction:: slice_source_at_stamps
     45.. code-block:: python
     46
     47    >>> import aubio
     48    >>> import numpy as np
     49
     50`Changed in 0.4.8` :  Prior to this version, almost no documentation was
     51provided with the python module. This version adds documentation for some
     52classes, including :class:`fvec`, :class:`cvec`, :class:`source`, and
     53:class:`sink`.
     54
     55.. _numpy: https://www.numpy.org

  • doc/python_module.rst

    r68daf5b rf8bf0c2  
    2626    $ sudo ./setup.py install
    2727
    28 Using aubio in python
    29 ---------------------
     28Checking your installation
     29--------------------------
    3030
    3131Once the python module is installed, its version can be checked with:
    … …  
    4141    $ aubio -h
    4242
    43 A simple example
    44 ................
    45 
    46 Here is a :download:`simple script <../python/demos/demo_source_simple.py>`
    47 that reads all the samples from a media file:
    48 
    49 .. literalinclude:: ../python/demos/demo_source_simple.py
    50    :language: python
    51 
    52 Filtering an input sound file
    53 .............................
    54 
    55 Here is a more complete example, :download:`demo_filter.py
    56 <../python/demos/demo_filter.py>`. This files executes the following:
    57 
    58 * read an input media file (``aubio.source``)
    59 
    60 * filter it using an `A-weighting <https://en.wikipedia.org/wiki/A-weighting>`_
    61   filter (``aubio.digital_filter``)
    62 
    63 * write result to a new file (``aubio.sink``)
    64 
    65 .. literalinclude:: ../python/demos/demo_filter.py
    66    :language: python
    67 
    68 More demos
    69 ..........
    70 
    71 Check out the `python demos folder`_ for more examples.
    7243
    7344Python tests
    … …  
    7748``python/tests/run_all_tests``.
    7849
    79 .. _python demos folder: https://github.com/aubio/aubio/blob/master/python/demos
    8050.. _demo_filter.py: https://github.com/aubio/aubio/blob/master/python/demos/demo_filter.py
    8151.. _python tests: https://github.com/aubio/aubio/blob/master/python/tests
Note: See TracChangeset for help on using the changeset viewer.