[doc] add a note about building the module in double precision

diff --git a/doc/py_datatypes.rst b/doc/py_datatypes.rst
index feae020..21fad69 100644 (file)
--- a/doc/py_datatypes.rst
+++ b/doc/py_datatypes.rst
@@ -17,8 +17,8 @@ This section contains the documentation for :data:`float_type`,
     Defaults to `"float32"`.
 
     If `aubio` was built specifically with the option `--enable-double`, this
-    string will be defined to `"float64"`. See :ref:`doubleprecision` in
-    :ref:`requirements` for more details on building aubio in double
+    string will be defined to `"float64"`. See :ref:`py-doubleprecision` in
+    :ref:`python-install` for more details on building aubio in double
     precision mode.
 
     .. rubric:: Examples

diff --git a/doc/py_utils.rst b/doc/py_utils.rst
index f96784e..6d19c0b 100644 (file)
--- a/doc/py_utils.rst
+++ b/doc/py_utils.rst
@@ -4,7 +4,7 @@
 Utilities
 ---------
 
-This section documents various helpers functions included in the aubio library.
+This section documents various helper functions included in the aubio library.
 
 Note name conversion
 ....................

diff --git a/doc/python_module.rst b/doc/python_module.rst
index e008a31..cb4d595 100644 (file)
--- a/doc/python_module.rst
+++ b/doc/python_module.rst
@@ -25,6 +25,29 @@ From ``aubio`` source directory, run the following:
     $ ./setup.py build
     $ sudo ./setup.py install
 
+
+.. _py-doubleprecision:
+
+Double precision
+----------------
+
+This module can be compiled in double-precision mode, in which case the
+default type for floating-point samples will be 64-bit. The default is
+single precision mode (32-bit, recommended).
+
+To build the aubio module with double precision, use the option
+`--enable-double` of the `build_ext` subcommand:
+
+.. code:: bash
+
+    $ ./setup.py clean
+    $ ./setup.py build_ext --enable-double
+    $ pip install -v .
+
+**Note**: If linking against `libaubio`, make sure the library was also
+compiled in :ref:`doubleprecision` mode.
+
+
 Checking your installation
 --------------------------
 

diff --git a/doc/requirements.rst b/doc/requirements.rst
index 22308eb..078f7c6 100644 (file)
--- a/doc/requirements.rst
+++ b/doc/requirements.rst
@@ -297,12 +297,15 @@ Here is an example of a custom command:
                 --manpagesdir=/opt/share/man  \
                 uninstall clean distclean dist distcheck
 
+.. _doubleprecision:
+
 Double precision
 ................
 
 To compile aubio in double precision mode, configure with ``--enable-double``.
 
-To compile aubio in single precision mode, use ``--disable-double`` (default).
+To compile aubio in single precision mode, use ``--disable-double`` (default,
+recommended).
 
 Disabling the tests
 ...................