moved module docstrings to the __init__.py files so they're picked up by sphinx

Author: pavelkomarov

pynumdiff/finite_difference/__init__.py

@@ -1,3 +1,5 @@
+"""This module implements some common finite difference schemes
+"""
 from ._finite_difference import first_order, second_order
 
 __all__ = ['first_order', 'second_order'] # So these get treated as direct members of the module by sphinx

pynumdiff/finite_difference/_finite_difference.py

@@ -1,6 +1,3 @@
-"""
-This module implements some common finite difference schemes
-"""
 import numpy as np
 from pynumdiff.utils import utility
 from warnings import warn

pynumdiff/kalman_smooth/__init__.py

@@ -1,3 +1,5 @@
+"""This module implements Kalman filters
+"""
 from ._kalman_smooth import constant_velocity, constant_acceleration, constant_jerk, known_dynamics, savgol_const_accel
 
 __all__ = ['constant_velocity', 'constant_acceleration', 'constant_jerk', 'known_dynamics', 'savgol_const_accel'] # So these get treated as direct members of the module by sphinx

pynumdiff/kalman_smooth/_kalman_smooth.py

@@ -1,6 +1,3 @@
-"""
-This module implements Kalman filters
-"""
 import copy
 import numpy as np
 

pynumdiff/linear_model/__init__.py

@@ -1,3 +1,5 @@
+"""This module implements interpolation-based differentiation schemes.
+"""
 try:
     import cvxpy
     from ._linear_model import lineardiff

pynumdiff/smooth_finite_difference/__init__.py

@@ -1,4 +1,5 @@
-
+"""Apply smoothing method before finite difference.
+"""
 from ._smooth_finite_difference import mediandiff, meandiff, gaussiandiff, friedrichsdiff, butterdiff, splinediff
 
 __all__ = ['mediandiff', 'meandiff', 'gaussiandiff', 'friedrichsdiff', 'butterdiff', 'splinediff'] # So these get treated as direct members of the module by sphinx

pynumdiff/smooth_finite_difference/_smooth_finite_difference.py

@@ -1,6 +1,3 @@
-"""
-Apply smoothing method before finite difference
-"""
 import numpy as np
 import scipy.signal
 

pynumdiff/total_variation_regularization/__init__.py

@@ -1,3 +1,5 @@
+"""This module implements some common total variation regularization methods
+"""
 try:
     import cvxpy
     from ._total_variation_regularization import velocity, acceleration, jerk, jerk_sliding, smooth_acceleration

pynumdiff/total_variation_regularization/_total_variation_regularization.py

@@ -1,6 +1,3 @@
-"""
-This module implements some common total variation regularization methods
-"""
 import logging
 import numpy as np