Update package and module imports to use the new package name

Universite-Gustave-Eiffel · Jul 24, 2024 · 677ea0c · 677ea0c
1 parent dfe54cf
commit 677ea0c
Show file tree

Hide file tree

Showing 28 changed files with 115 additions and 101 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -4,6 +4,8 @@ build:
   os: "ubuntu-22.04"
   tools:
     python: "3.10"
+  apt_packages:
+    - graphviz
 
 python:
   install:

diff --git a/acoustic_toolbox/__init__.py b/acoustic_toolbox/__init__.py
@@ -1,6 +1,6 @@
 """
 Acoustic Toolbox
-=========
+================
 
 The acoustic_toolbox module.
 

diff --git a/acoustic_toolbox/cepstrum.py b/acoustic_toolbox/cepstrum.py
@@ -31,7 +31,7 @@ def complex_cepstrum(x, n=None):
 
     .. math:: c[n] = F^{-1}\\left{\\log_{10}{\\left(F{x[n]}\\right)}\\right}
 
-    where :math:`x_[n]` is the input signal and :math:`F` and :math:`F_{-1}
+    where :math:`x_[n]` is the input signal and :math:`F` and :math:`F_{-1}`
     are respectively the forward and backward Fourier transform.
 
     See Also
@@ -121,7 +121,7 @@ def real_cepstrum(x, n=None):
 
     .. math:: c[n] = F^{-1}\left{\log_{10}{\left|F{x[n]}\right|}\right}
 
-    where :math:`x_[n]` is the input signal and :math:`F` and :math:`F_{-1}
+    where :math:`x_[n]` is the input signal and :math:`F` and :math:`F_{-1}`
     are respectively the forward and backward Fourier transform. Note that
     contrary to the complex cepstrum the magnitude is taken of the spectrum.
 
@@ -165,7 +165,7 @@ def inverse_complex_cepstrum(ceps, ndelay):
 
     .. math:: x[n] = F^{-1}\left{\exp(F(c[n]))\right}
 
-    where :math:`c_[n]` is the input signal and :math:`F` and :math:`F_{-1}
+    where :math:`c_[n]` is the input signal and :math:`F` and :math:`F_{-1}`
     are respectively the forward and backward Fourier transform.
 
     See Also
@@ -233,7 +233,7 @@ def minimum_phase(x, n=None):
 
     References
     ----------
-    .. [1] Soo-Chang Pei, Huei-Shan Lin. Minimum-Phase FIR Filter Design Using
+    .. `[1]` Soo-Chang Pei, Huei-Shan Lin. Minimum-Phase FIR Filter Design Using
            Real Cepstrum. IEEE TRANSACTIONS ON CIRCUITS AND SYSTEMS-II:
            EXPRESS BRIEFS, VOL. 53, NO. 10, OCTOBER 2006
 

diff --git a/acoustic_toolbox/octave.py b/acoustic_toolbox/octave.py
@@ -6,7 +6,7 @@
 
 The following is an example on how to use :class:`acoustic_toolbox.octave.Octave`.
 
-.. literalinclude:: ../examples/octave.py
+.. literalinclude:: ../../examples/example_octave.py
 
 """
 import numpy as np

diff --git a/acoustic_toolbox/standards/iso_tr_25417_2007.py b/acoustic_toolbox/standards/iso_tr_25417_2007.py
@@ -6,10 +6,8 @@
 in noise measurement documents prepared by ISO Technical Committee TC 43,
 Acoustics, Subcommittee SC 1, Noise, together with their symbols and units, with
 the principal aim of harmonizing the terminology used in ISO25417 : (http://www.iso.org/iso/home/store/catalogue_tc/catalogue_detail.htm?csnumber=42915).
-
-.. inheritance-diagram:: acoustic_toolbox.standards.iso_tr_25417_2007
-
 """
+
 import numpy as np
 
 REFERENCE_PRESSURE = 2.0e-5

diff --git a/docs/source/ambisonics.rst b/docs/source/ambisonics.rst
@@ -1 +1,3 @@
 .. automodule:: acoustic_toolbox.ambisonics
+    :noindex:
+    :members:
diff --git a/docs/source/bands.rst b/docs/source/bands.rst
@@ -1,2 +1,3 @@
 .. automodule:: acoustic_toolbox.bands
-
+    :noindex:
+    :members:
diff --git a/docs/source/building.rst b/docs/source/building.rst
@@ -1,2 +1,4 @@
 .. automodule:: acoustic_toolbox.building
-
+    :noindex:
+    :members:
+
diff --git a/docs/source/cepstrum.rst b/docs/source/cepstrum.rst
@@ -1 +1,3 @@
 .. automodule:: acoustic_toolbox.cepstrum
+    :noindex:
+    :members:
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -1,5 +1,13 @@
 # Configuration file for the Sphinx documentation builder.
 
+import sys
+import os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+sys.path.insert(0, os.path.abspath('../..'))
+
 # -- Project information
 
 project = 'Acoustic-Toolbox'
@@ -17,19 +25,30 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'sphinx.ext.intersphinx',
+    "sphinx.ext.inheritance_diagram",
 ]
 
 intersphinx_mapping = {
     'python': ('https://docs.python.org/3/', None),
-    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
+    'scipy': ('https://docs.scipy.org/doc/scipy/', None),
+    'numpy': ('https://numpy.org/doc/stable/', None),
+    'pandas': ('https://pandas.pydata.org/docs/', None),
+    'matplotlib': ('https://matplotlib.org/stable/', None)
 }
+
 intersphinx_disabled_domains = ['std']
 
 templates_path = ['_templates']
 
+# autodoc_default_options = {
+#     'members': True,
+# }
+
 # -- Options for HTML output
 
 html_theme = 'sphinx_rtd_theme'
 
 # -- Options for EPUB output
 epub_show_urls = 'footnote'
+
+# graphviz_dot = 'dot'
diff --git a/docs/source/criterion.rst b/docs/source/criterion.rst
@@ -1,10 +1,4 @@
-Criterion
-=========
-
-.. toctree::
-    :maxdepth: 2
-
-.. inheritance-diagram:: acoustic_toolbox.criterion
 .. automodule:: acoustic_toolbox.criterion
-    :show-inheritance:
+    :noindex:
+    :members:
 
diff --git a/docs/source/decibel.rst b/docs/source/decibel.rst
@@ -1 +1,3 @@
 .. automodule:: acoustic_toolbox.decibel
+    :noindex:
+    :members:
diff --git a/docs/source/descriptors.rst b/docs/source/descriptors.rst
@@ -1,2 +1,3 @@
 .. automodule:: acoustic_toolbox.descriptors
+    :no-members:
 
diff --git a/docs/source/directivity.rst b/docs/source/directivity.rst
@@ -1 +1,3 @@
 .. automodule:: acoustic_toolbox.directivity
+    :noindex:
+    :members:
diff --git a/docs/source/doppler.rst b/docs/source/doppler.rst
@@ -1 +1,3 @@
 .. automodule:: acoustic_toolbox.doppler
+    :noindex:
+    :members:
diff --git a/docs/source/imaging.rst b/docs/source/imaging.rst
@@ -1,2 +1,3 @@
 .. automodule:: acoustic_toolbox.imaging
-
+    :noindex:
+    :members:
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,21 +1,59 @@
-.. acoustic-toolbox documentation master file, created by
-   sphinx-quickstart on Fri Aug 16 09:40:59 2013.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+.. acoustic-toolbox documentation master file
+
+Acoustic Toolbox
+================
 
 Welcome to the documentation of the acoustic-toolbox module!
-=====================================================
 
+API Reference
+#############
+
+This section contains a description of all classes and functions.
 
+Signal class
+------------
 
+.. toctree::
+   :maxdepth: 1
 
-Contents:
+   signal
 
+Modules
+-------
 
 .. toctree::
    :maxdepth: 1
-
-   reference
+
+   ambisonics
+   atmosphere
+   bands
+   building
+   cepstrum
+   criterion
+   decibel
+   generator
+   descriptors
+   directivity
+   doppler
+   imaging
+   octave
+   power
+   reflection
+   room
+   utils
+   weighting
+   quantity
+
+Standards
+---------
+
+The ``acoustic_toolbox.standards`` module consists of modules where all code and
+values are according to the respective standard.
+
+.. toctree::
+   :maxdepth: 1
+
+   standards
 
 Indices and tables
 ==================

diff --git a/docs/source/octave.rst b/docs/source/octave.rst
@@ -1 +1,3 @@
 .. automodule:: acoustic_toolbox.octave
+    :noindex:
+    :members:
diff --git a/docs/source/power.rst b/docs/source/power.rst
@@ -1 +1,3 @@
 .. automodule:: acoustic_toolbox.power
+    :noindex:
+    :members:
diff --git a/docs/source/quantity.rst b/docs/source/quantity.rst
@@ -1,3 +1,3 @@
 .. automodule:: acoustic_toolbox.quantity
-
-
+    :noindex:
+    :members:
diff --git a/docs/source/reference.rst b/docs/source/reference.rst
diff --git a/docs/source/reflection.rst b/docs/source/reflection.rst
@@ -1 +1,3 @@
 .. automodule:: acoustic_toolbox.reflection
+    :noindex:
+    :members:
diff --git a/docs/source/room.rst b/docs/source/room.rst
@@ -1,2 +1,4 @@
 .. automodule:: acoustic_toolbox.room
+    :noindex:
+    :members:
 
diff --git a/docs/source/signal.rst b/docs/source/signal.rst
@@ -1,2 +1,4 @@
 .. automodule:: acoustic_toolbox.signal
-    :no-members:
+    :noindex:
+    :members:
+
diff --git a/docs/source/standards.rst b/docs/source/standards.rst
@@ -1,3 +1,4 @@
 .. automodule:: acoustic_toolbox.standards
-    :show-inheritance:
-
+    :noindex:
+    :members:
+
diff --git a/docs/source/turbulence.rst b/docs/source/turbulence.rst
diff --git a/docs/source/utils.rst b/docs/source/utils.rst
@@ -1 +1,3 @@
 .. automodule:: acoustic_toolbox.utils
+    :noindex:
+    :members:
diff --git a/docs/source/weighting.rst b/docs/source/weighting.rst
@@ -1 +1,3 @@
 .. automodule:: acoustic_toolbox.weighting
+    :noindex:
+    :members:
Original file line number	Diff line number	Diff line change
		@@ -1,2 +1,3 @@
		.. automodule:: acoustic_toolbox.descriptors
		:no-members: