shithub: aubio

Info  •  Files  •  Log  •  Branches

[doc] move python tests from python/README.md to doc/python_module.rst

--- a/doc/python_module.rst

+++ b/doc/python_module.rst

@@ -67,8 +67,14 @@

 Python tests

 ------------

-A number of `python tests`_ are provided. To run them, use

-``python/tests/run_all_tests``.

+A number of Python tests are provided in the `python tests`_. To run them,

+install `nose2`_ and run the script ``python/tests/run_all_tests``:

+.. code-block:: console

+

+    $ pip install nose2

+    $ ./python/tests/run_all_tests

+

 .. _demo_filter.py: https://github.com/aubio/aubio/blob/master/python/demos/demo_filter.py

 .. _python tests: https://github.com/aubio/aubio/blob/master/python/tests

+.. _nose2: https://github.com/nose-devs/nose2

--- a/python/README.md

+++ b/python/README.md

@@ -76,21 +76,6 @@

 [PySoundCard](https://github.com/bastibe/PySoundCard) to play and record

 sounds.

-Testing the Python module

--------------------------

-

-Python tests are in `python/tests` and use the [nose2 python package][nose2].

-

-To run the all the python tests, use the script:

-

-    $ ./python/tests/run_all_tests

-

-Each test script can also be called one at a time. For instance:

-

-    $ ./python/tests/test_note2midi.py -v

-

-[nose2]: https://github.com/nose-devs/nose2

-

 For more information about how this module works, please refer to the [Python/C

 API Reference Manual] (http://docs.python.org/c-api/index.html) and the

 [Numpy/C API Reference](http://docs.scipy.org/doc/numpy/reference/c-api.html).