ref: 6d4802ff4ab2e93562f47db44a211e03ef002bdc
parent: a4a00a5882c594ec02b8375f02cd40c1a1661cb4
author: Paul Brossier <piem@piem.org>
date: Wed Oct 31 13:12:21 EDT 2018
[doc] add a note about building the module in double precision
--- a/doc/py_datatypes.rst
+++ b/doc/py_datatypes.rst
@@ -17,8 +17,8 @@
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
--- 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
....................
--- a/doc/python_module.rst
+++ b/doc/python_module.rst
@@ -25,6 +25,29 @@
$ ./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
--------------------------
--- a/doc/requirements.rst
+++ b/doc/requirements.rst
@@ -297,12 +297,15 @@
--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
...................