Bug: Doc: clean up imports in doc

.circleci/config.yml

@@ -83,7 +83,7 @@ jobs:
           command: |
             pip install ".[docs]"
             cd docs/
-            make html
+            make html SPHINXOPTS="-W"
 
   test_deprecation_warnings:
     parameters:

.gitignore

@@ -124,6 +124,7 @@ docs/header.rst
 docs/_static/favicon.ico
 docs/_static/header.rst
 docs/_static/css/custom.css
+docs/_static/js/custom.js
 docs/resources/logos/pyfar_logos_fixed_size_spharpy.png
 
 # ignore plot output

docs/api_reference.rst

@@ -25,11 +25,11 @@ Modules
    :maxdepth: 1
 
    modules/spharpy.beamforming
-   modules/spharpy.indexing
    modules/spharpy.interpolate
    modules/spharpy.plot
    modules/spharpy.samplings
    modules/spharpy.spatial
+   modules/spharpy.special
    modules/spharpy.spherical
    modules/spharpy.transforms
 

docs/spharpy.special.rst → docs/modules/spharpy.special.rst

@@ -1,7 +1,8 @@
 spharpy.special
------------------
+---------------
 
 .. automodule:: spharpy.special
    :members:
+   :special-members: __init__
    :undoc-members:
    :show-inheritance:

spharpy/classes/audio.py

@@ -52,7 +52,7 @@ class SphericalHarmonicSignal(Signal):
     fft_norm : str, optional
         The normalization of the Discrete Fourier Transform (DFT). Can be
         ``'none'``, ``'unitary'``, ``'amplitude'``, ``'rms'``, ``'power'``,
-        or ``'psd'``. See :py:func:`~pyfar.dsp.fft.normalization` and [#]_
+        or ``'psd'``. See :py:func:`~pyfar.dsp.fft.normalization`
         for more information. The default is ``'none'``, which is typically
         used for energy signals, such as impulse responses.
     comment : str

spharpy/spherical.py

@@ -93,6 +93,8 @@ def nm_to_fuma(n, m):
     and degree m, according to the FuMa (Furse-Malham)
     Channel Ordering Convention.
 
+    See [#]_ for details.
+
     Parameters
     ----------
     n : integer, ndarray
@@ -137,7 +139,9 @@ def fuma_to_nm(fuma):
     r"""
     Calculate the spherical harmonic order n and degree m for a linear
     coefficient index, according to the FuMa (Furse-Malham)
-    Channel Ordering Convention [#]_.
+    Channel Ordering Convention.
+
+    See [#]_ for details.
 
     FuMa = WXYZ | RSTUV | KLMNOPQ
     ACN = WYZX | VTRSU | QOMKLNP
@@ -459,6 +463,8 @@ def spherical_harmonic_basis_gradient(n_max, coordinates, normalization="n3d",
     r"""
     Calculates the unit sphere gradients of the complex spherical harmonics.
 
+    This implementation avoids singularities at the poles using identities
+    derived in [#]_.
 
     The angular parts of the gradient are defined as
 
@@ -471,13 +477,8 @@ def spherical_harmonic_basis_gradient(n_max, coordinates, normalization="n3d",
         {\partial \theta} \vec{e}_\theta .
 
 
-    This implementation avoids singularities at the poles using identities
-    derived in [#]_.
-
-
     References
     ----------
-    .. [#]  E. G. Williams, Fourier Acoustics. Academic Press, 1999.
     .. [#]  J. Du, C. Chen, V. Lesur, and L. Wang, “Non-singular spherical
             harmonic expressions of geomagnetic vector and gradient tensor
             fields in the local north-oriented reference frame,” Geoscientific
@@ -658,8 +659,8 @@ def spherical_harmonic_basis_gradient_real(n_max, coordinates,
     Calculates the unit sphere gradients of the real valued spherical
     harmonics.
 
-    The spherical harmonic functions are fully normalized (N3D) and follow
-    the AmbiX phase convention [#]_.
+    This implementation avoids singularities at the poles using identities
+    derived in [#]_.
 
     The angular parts of the gradient are defined as
 
@@ -672,16 +673,8 @@ def spherical_harmonic_basis_gradient_real(n_max, coordinates,
         {\partial \theta} \vec{e}_\theta .
 
 
-    This implementation avoids singularities at the poles using identities
-    derived in [#]_.
-
-
     References
     ----------
-    .. [#]  C. Nachbar, F. Zotter, E. Deleflie, and A. Sontacchi, “Ambix - A
-            Suggested Ambisonics Format (revised by F. Zotter),” International
-            Symposium on Ambisonics and Spherical Acoustics,
-            vol. 3, pp. 1-11, 2011.
     .. [#]  J. Du, C. Chen, V. Lesur, and L. Wang, “Non-singular spherical
             harmonic expressions of geomagnetic vector and gradient tensor
             fields in the local north-oriented reference frame,” Geoscientific