Add dependencies to pyproject.toml and integrate examples notebooks i…

…nto docs (#15) * add dependencies to pyproject.toml * Integrate examples ipynb into documentation * ruff format * restore rendered outputs
Universite-Gustave-Eiffel · Aug 2, 2024 · ec88c31 · ec88c31
1 parent ada5e58
commit ec88c31
Show file tree

Hide file tree

Showing 8 changed files with 64 additions and 22 deletions.
diff --git a/.gitignore b/.gitignore
@@ -58,3 +58,4 @@ _build
 .ipynb_checkpoints
 
 temp
+/.idea
diff --git a/acoustic_toolbox/signal.py b/acoustic_toolbox/signal.py
@@ -2,7 +2,7 @@
 Signal
 ======
 
-The signal module constains all kinds of signal processing related functions.
+The signal module contains all kinds of signal processing related functions.
 
 .. inheritance-diagram:: acoustic_toolbox.signal
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,5 +1,10 @@
 sphinx==7.1.2
 sphinx-rtd-theme==1.3.0rc1
+nbsphinx>=0.9.4
+nbsphinx-link>=1.3.0
+jupyter>=1.0.0
+
+
 
 numpy
 scipy

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -6,49 +6,51 @@
 # 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('../..'))
+sys.path.insert(0, os.path.abspath("../.."))
 
 # -- Project information
 
-project = 'Acoustic-Toolbox'
-copyright = '2024, Valentin LE BESCOND'
-author = 'Valentin LE BESCOND'
+project = "Acoustic-Toolbox"
+copyright = "2024, Valentin LE BESCOND"
+author = "Valentin LE BESCOND"
 
-release = '0.1'
-version = '0.1.0'
+release = "0.1"
+version = "0.1.0"
 
 # -- General configuration
 
 extensions = [
-    'sphinx.ext.duration',
-    'sphinx.ext.doctest',
-    'sphinx.ext.autodoc',
-    'sphinx.ext.autosummary',
-    'sphinx.ext.intersphinx',
+    "sphinx.ext.duration",
+    "sphinx.ext.doctest",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.intersphinx",
     "sphinx.ext.inheritance_diagram",
+    "nbsphinx",
+    "nbsphinx_link",
 ]
 
 intersphinx_mapping = {
-    'python': ('https://docs.python.org/3/', 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)
+    "python": ("https://docs.python.org/3/", 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']
+intersphinx_disabled_domains = ["std"]
 
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # autodoc_default_options = {
 #     'members': True,
 # }
 
 # -- Options for HTML output
 
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
 # -- Options for EPUB output
-epub_show_urls = 'footnote'
+epub_show_urls = "footnote"
 
-# graphviz_dot = 'dot'
+# graphviz_dot = 'dot'
diff --git a/docs/source/directivity.nblink b/docs/source/directivity.nblink
@@ -0,0 +1,3 @@
+{
+    "path": "../../examples/directivity.ipynb"
+}
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -5,6 +5,15 @@ Acoustic Toolbox
 
 Welcome to the documentation of the acoustic-toolbox module!
 
+Examples
+########
+
+.. toctree::
+   :maxdepth: 1
+
+   signal_class
+   directivity
+
 API Reference
 #############
 

diff --git a/docs/source/signal_class.nblink b/docs/source/signal_class.nblink
@@ -0,0 +1,3 @@
+{
+    "path": "../../examples/signal_class.ipynb"
+}
diff --git a/pyproject.toml b/pyproject.toml
@@ -16,6 +16,13 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 dependencies = [
+    "numpy>=2.0.1",
+    "scipy>=1.14.0",
+    "matplotlib>=3.9.1",
+    "six>=1.16.0",
+    "pandas>=2.2.2",
+    "tabulate>=0.9.0",
+    "pysoundfile>=0.9.0.post1",
 ]
 
 [project.license]
@@ -25,5 +32,17 @@ file = "LICENSE"
 "Homepage" = "https://github.com/Universite-Gustave-Eiffel/acoustic-toolbox"
 "Bug Tracker" = "https://github.com/Universite-Gustave-Eiffel/acoustic-toolbox/issues"
 
+[project.optional-dependencies]
+docs = [
+    "sphinx-rtd-theme==1.3.0rc1",
+    "sphinx>=1.6, <8",
+    "nbsphinx>=0.9.4",
+    "nbsphinx-link>=1.3.0",
+    "jupyter>=1.0.0",
+]
+test = [
+    "pytest>=8.3.2",
+]
+
 [tool.flit.sdist]
 include = ["tests/"]