Merge branch 'feature/issue-218/sphinx' of https://github.com/childmindresearch/wristpy into feature/issue-218/sphinx

frey-perez · frey-perez · commit 11fc52e347b5 · 2025-09-18T16:52:04.000-04:00
diff --git a/.gitattributes b/.gitattributes
@@ -1,2 +1 @@
 docs/source/tutorial_data/three_nights.bin filter=lfs diff=lfs merge=lfs -text
-
diff --git a/docs/source/api/wristpy.core.cli.rst b/docs/source/api/wristpy.core.cli.rst
@@ -3,21 +3,21 @@
 
 .. automodule:: wristpy.core.cli
 
-   
+
    .. rubric:: Functions
 
    .. autosummary::
-   
+
       main
       version_check
-   
+
    .. rubric:: Classes
 
    .. autosummary::
-   
+
       ActivityMetric
       Calibrator
       Enum
       NonwearAlgorithms
       OutputFileType
-   
+
diff --git a/docs/source/api/wristpy.core.computations.rst b/docs/source/api/wristpy.core.computations.rst
@@ -3,13 +3,13 @@
 
 .. automodule:: wristpy.core.computations
 
-   
+
    .. rubric:: Functions
 
    .. autosummary::
-   
+
       moving_mean
       moving_median
       moving_std
       resample
-   
+
diff --git a/docs/source/api/wristpy.core.config.rst b/docs/source/api/wristpy.core.config.rst
@@ -3,11 +3,11 @@
 
 .. automodule:: wristpy.core.config
 
-   
+
    .. rubric:: Functions
 
    .. autosummary::
-   
+
       get_logger
       get_version
-   
+
diff --git a/docs/source/api/wristpy.core.exceptions.rst b/docs/source/api/wristpy.core.exceptions.rst
@@ -3,15 +3,15 @@
 
 .. automodule:: wristpy.core.exceptions
 
-   
+
    .. rubric:: Exceptions
 
    .. autosummary::
-   
+
       CalibrationError
       EmptyDirectoryError
       InvalidFileTypeError
       LoggedException
       NoMotionError
       SphereCriteriaError
-   
+
diff --git a/docs/source/api/wristpy.core.models.rst b/docs/source/api/wristpy.core.models.rst
@@ -3,18 +3,18 @@
 
 .. automodule:: wristpy.core.models
 
-   
+
    .. rubric:: Functions
 
    .. autosummary::
-   
+
       field_validator
-   
+
    .. rubric:: Classes
 
    .. autosummary::
-   
+
       BaseModel
       Measurement
       WatchData
-   
+
diff --git a/docs/source/api/wristpy.core.orchestrator.rst b/docs/source/api/wristpy.core.orchestrator.rst
@@ -3,10 +3,10 @@
 
 .. automodule:: wristpy.core.orchestrator
 
-   
+
    .. rubric:: Functions
 
    .. autosummary::
-   
+
       run
-   
+
diff --git a/docs/source/api/wristpy.io.readers.readers.rst b/docs/source/api/wristpy.io.readers.readers.rst
@@ -3,11 +3,11 @@ wristpy.io.readers.readers
 
 .. automodule:: wristpy.io.readers.readers
 
-   
+
    .. rubric:: Functions
 
    .. autosummary::
-   
+
       read_watch_data
       unix_epoch_time_to_polars_datetime
-   
+
diff --git a/docs/source/api/wristpy.io.readers.rst b/docs/source/api/wristpy.io.readers.rst
@@ -3,7 +3,7 @@
 
 .. automodule:: wristpy.io.readers
 
-   
+
 .. rubric:: Modules
 
 .. autosummary::
diff --git a/docs/source/api/wristpy.io.writers.rst b/docs/source/api/wristpy.io.writers.rst
@@ -3,7 +3,7 @@
 
 .. automodule:: wristpy.io.writers
 
-   
+
 .. rubric:: Modules
 
 .. autosummary::
diff --git a/docs/source/api/wristpy.io.writers.writers.rst b/docs/source/api/wristpy.io.writers.writers.rst
@@ -3,11 +3,11 @@ wristpy.io.writers.writers
 
 .. automodule:: wristpy.io.writers.writers
 
-   
+
    .. rubric:: Classes
 
    .. autosummary::
-   
+
       Any
       OrchestratorResults
-   
+
diff --git a/docs/source/api/wristpy.processing.analytics.rst b/docs/source/api/wristpy.processing.analytics.rst
@@ -3,21 +3,21 @@
 
 .. automodule:: wristpy.processing.analytics
 
-   
+
    .. rubric:: Functions
 
    .. autosummary::
-   
+
       compute_physical_activty_categories
       dataclass
       sleep_bouts_cleanup
       sleep_cleanup
-   
+
    .. rubric:: Classes
 
    .. autosummary::
-   
+
       GgirSleepDetection
       SleepParameters
       SleepWindow
-   
+
diff --git a/docs/source/api/wristpy.processing.calibration.rst b/docs/source/api/wristpy.processing.calibration.rst
@@ -3,23 +3,23 @@
 
 .. automodule:: wristpy.processing.calibration
 
-   
+
    .. rubric:: Functions
 
    .. autosummary::
-   
+
       cast
       dataclass
-   
+
    .. rubric:: Classes
 
    .. autosummary::
-   
+
       AbstractCalibrator
       CalibrationDispatcher
       ConstrainedMinimizationCalibration
       Generator
       GgirCalibration
       LinearTransformation
       datetime
-   
+
diff --git a/docs/source/api/wristpy.processing.idle_sleep_mode_imputation.rst b/docs/source/api/wristpy.processing.idle_sleep_mode_imputation.rst
@@ -3,10 +3,10 @@
 
 .. automodule:: wristpy.processing.idle_sleep_mode_imputation
 
-   
+
    .. rubric:: Functions
 
    .. autosummary::
-   
+
       impute_idle_sleep_mode_gaps
-   
+
diff --git a/docs/source/api/wristpy.processing.metrics.rst b/docs/source/api/wristpy.processing.metrics.rst
@@ -3,11 +3,11 @@
 
 .. automodule:: wristpy.processing.metrics
 
-   
+
    .. rubric:: Functions
 
    .. autosummary::
-   
+
       actigraph_activity_counts
       angle_relative_to_horizontal
       combined_temp_accel_detect_nonwear
@@ -16,4 +16,4 @@
       euclidean_norm_minus_one
       mean_amplitude_deviation
       monitor_independent_movement_summary_units
-   
+
diff --git a/docs/source/api/wristpy.processing.mims.rst b/docs/source/api/wristpy.processing.mims.rst
@@ -3,14 +3,14 @@
 
 .. automodule:: wristpy.processing.mims
 
-   
+
    .. rubric:: Functions
 
    .. autosummary::
-   
+
       aggregate_mims
       butterworth_filter
       combine_mims
       extrapolate_points
       interpolate_measure
-   
+
diff --git a/docs/source/api/wristpy.processing.processing_utils.rst b/docs/source/api/wristpy.processing.processing_utils.rst
@@ -3,11 +3,11 @@
 
 .. automodule:: wristpy.processing.processing_utils
 
-   
+
    .. rubric:: Functions
 
    .. autosummary::
-   
+
       get_nonwear_measurements
       synchronize_measurements
-   
+
diff --git a/docs/source/getting_started.ipynb b/docs/source/getting_started.ipynb
diff --git a/docs/source/index.rst b/docs/source/index.rst
diff --git a/pyproject.toml b/pyproject.toml

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1 @@`
`1`	`1`	`docs/source/tutorial_data/three_nights.bin filter=lfs diff=lfs merge=lfs -text`
`2`		`-`