childmindresearch · frey-perez · Aug 13, 2025 · Aug 13, 2025 · Aug 13, 2025 · Aug 13, 2025
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -4,32 +4,42 @@ permissions:
   contents: write
 
 on:
-  workflow_run:
-    workflows: [Python Tests]
-    types:
-    - completed
+  push:
     branches:
-    - main
+      - feature/issue-218/sphinx
+      - main
+  workflow_dispatch:
 
 jobs:
   build-and-publish-docs:
-    if: ${{ github.event.workflow_run.conclusion == 'success' }}
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
+
     - name: Fetch LFS files
       run: git lfs pull
+
     - uses: actions/setup-python@v5
       with:
         python-version: '3.11'
+
     - name: Install dependencies
       run: |
         python -m pip install poetry
         poetry install --with docs
-    - name: Build docs
-      run: |
-        poetry run pdoc src/wristpy -o docs_build -t docs/pdoc-theme --docformat google
-        touch docs_build/.nojekyll
-    - uses: JamesIves/github-pages-deploy-action@v4
+
+      - name: Build Sphinx docs
+        working-directory: docs
+
+        run: |
+          poetry run make html
+          touch build/html/.nojekyll
+          ls -la build/html | sed 's/^/BUILD: /'
+
+    - name: Deploy to gh-pages
+      uses: JamesIves/github-pages-deploy-action@v4
       with:
-        folder: docs_build
+        branch: gh-pages
+        folder: docs/build/html
+        clean: true
+        single-commit: true
diff --git a/.gitignore b/.gitignore
@@ -76,6 +76,8 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/build/
+
 
 # PyBuilder
 .pybuilder/

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13883190.svg)](https://doi.org/10.5281/zenodo.13883190)
 
-# `wristpy` <img src="https://media.githubusercontent.com/media/childmindresearch/wristpy/main/docs/wristpy_logo.png" align="right" width="25%"/>
+# `wristpy` <img src="https://media.githubusercontent.com/media/childmindresearch/wristpy/main/docs/_static/images/wristpy_logo.png" align="right" width="25%"/>
 
  A Python package for wrist-worn accelerometer data processing.
 

diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,23 @@
+
+
+
+SPHINXOPTS    ?=
+SPHINXBUILD  ?= sphinx-build
+SOURCEDIR    = source
+BUILDDIR     = build
+
+
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+livehtml:
+	sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/pdoc-theme/syntax-highlighting.css b/docs/pdoc-theme/syntax-highlighting.css
diff --git a/docs/pdoc-theme/theme.css b/docs/pdoc-theme/theme.css
diff --git a/docs/enmo_anglez_example3.png → ...e/_static/images/enmo_anglez_example3.png b/docs/enmo_anglez_example3.png → ...e/_static/images/enmo_anglez_example3.png
diff --git a/docs/enmo_example1.png → docs/source/_static/images/enmo_example1.png b/docs/enmo_example1.png → docs/source/_static/images/enmo_example1.png
diff --git a/docs/filtered_sleep_windows.png → ..._static/images/filtered_sleep_windows.png b/docs/filtered_sleep_windows.png → ..._static/images/filtered_sleep_windows.png
diff --git a/docs/light_example2.png → .../source/_static/images/light_example2.png b/docs/light_example2.png → .../source/_static/images/light_example2.png
diff --git a/docs/nonwear_example4.png → ...ource/_static/images/nonwear_example4.png b/docs/nonwear_example4.png → ...ource/_static/images/nonwear_example4.png
diff --git a/docs/phys_levels_example1.png → ...e/_static/images/phys_levels_example1.png b/docs/phys_levels_example1.png → ...e/_static/images/phys_levels_example1.png
diff --git a/docs/raw_accel_example2.png → ...rce/_static/images/raw_accel_example2.png b/docs/raw_accel_example2.png → ...rce/_static/images/raw_accel_example2.png
diff --git a/docs/sleep_anglez_example1.png → .../_static/images/sleep_anglez_example1.png b/docs/sleep_anglez_example1.png → .../_static/images/sleep_anglez_example1.png
diff --git a/docs/sleep_angz_example5.png → ...ce/_static/images/sleep_angz_example5.png b/docs/sleep_angz_example5.png → ...ce/_static/images/sleep_angz_example5.png
diff --git a/docs/wristpy_logo.png → docs/source/_static/images/wristpy_logo.png b/docs/wristpy_logo.png → docs/source/_static/images/wristpy_logo.png
diff --git a/docs/source/api/wristpy.core.cli.rst b/docs/source/api/wristpy.core.cli.rst
@@ -0,0 +1,22 @@
+wristpy.core.cli
+================
+
+.. 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
@@ -0,0 +1,14 @@
+wristpy.core.computations
+=========================
+
+.. 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
@@ -0,0 +1,12 @@
+wristpy.core.config
+===================
+
+.. 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
@@ -0,0 +1,16 @@
+wristpy.core.exceptions
+=======================
+
+.. 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
@@ -0,0 +1,19 @@
+wristpy.core.models
+===================
+
+.. 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
@@ -0,0 +1,11 @@
+wristpy.core.orchestrator
+=========================
+
+.. automodule:: wristpy.core.orchestrator
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      run