Changeset 6d4802f for doc

Timestamp:

Oct 31, 2018, 5:12:21 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:

dc3f68d

Parents:

a4a00a5

Message:

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

Location:

doc

Files:

• py_datatypes.rst (modified) (1 diff)
• py_utils.rst (modified) (1 diff)
• python_module.rst (modified) (1 diff)
• requirements.rst (modified) (2 diffs)

doc/py_datatypes.rst

@@ -18 +18 @@
 
     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.
 

doc/py_utils.rst

@@ -5 +5 @@
 ---------
 
-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

doc/python_module.rst

@@ -26 +26 @@
     $ 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
 --------------------------

doc/requirements.rst

@@ -298 +298 @@
                 uninstall clean distclean dist distcheck
 
+.. _doubleprecision:
+
 Double precision
 ................
@@ -303 +305 @@
 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