Prepare for release

.github/workflows/docs.yml

@@ -0,0 +1,65 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - 'v*'
+  pull_request:
+    branches:
+      - dev
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Needed for hatch-vcs to determine version
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+          python-version: "3.12"
+
+      - name: Install the project
+        run: uv sync --only-group docs
+
+      - name: Build documentation
+        run: |
+          cd docs
+          uv run make html
+
+      - name: Add .nojekyll file
+        run: touch docs/build/html/.nojekyll
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'docs/build/html'
+
+  deploy:
+    # Only deploy on push to main or release tags
+    if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/v'))
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -70,8 +70,10 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/build/
 docs/source/_build
 docs/source/generated
+docs/source/api/generated
 
 # PyBuilder
 .pybuilder/

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/_templates/autosummary/module.rst

@@ -0,0 +1,64 @@
+{{ fullname | escape | underline}}
+
+.. automodule:: {{ fullname }}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: Module Attributes
+
+   .. autosummary::
+      :toctree:
+   {% for item in attributes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block functions %}
+   {% if functions %}
+   .. rubric:: Functions
+
+   {% for item in functions %}
+   .. autofunction:: {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block classes %}
+   {% if classes %}
+   .. rubric:: Classes
+
+   {% for item in classes %}
+   .. autoclass:: {{ item }}
+      :members:
+      :undoc-members:
+      :show-inheritance:
+      :special-members: __init__
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block exceptions %}
+   {% if exceptions %}
+   .. rubric:: Exceptions
+
+   {% for item in exceptions %}
+   .. autoexception:: {{ item }}
+      :members:
+      :show-inheritance:
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+{% block modules %}
+{% if modules %}
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :recursive:
+{% for item in modules %}
+   {{ item }}
+{%- endfor %}
+{% endif %}
+{% endblock %}

docs/source/api/index.rst

@@ -0,0 +1,157 @@
+API Reference
+=============
+
+This page contains the complete API reference for ``ezmsg.sigproc``.
+
+.. contents:: Modules
+   :local:
+   :depth: 1
+
+Base Processors
+---------------
+
+Core processor protocols and base classes.
+
+.. autosummary::
+   :toctree: generated
+   :recursive:
+
+   ezmsg.sigproc.base
+
+Filtering
+---------
+
+Various filter implementations for signal processing.
+
+.. autosummary::
+   :toctree: generated
+   :recursive:
+
+   ezmsg.sigproc.filter
+   ezmsg.sigproc.butterworthfilter
+   ezmsg.sigproc.cheby
+   ezmsg.sigproc.combfilter
+   ezmsg.sigproc.adaptive_lattice_notch
+   ezmsg.sigproc.firfilter
+   ezmsg.sigproc.kaiser
+   ezmsg.sigproc.ewmfilter
+   ezmsg.sigproc.filterbank
+   ezmsg.sigproc.filterbankdesign
+   ezmsg.sigproc.gaussiansmoothing
+
+Spectral Analysis
+-----------------
+
+Spectral and frequency domain analysis tools.
+
+.. autosummary::
+   :toctree: generated
+   :recursive:
+
+   ezmsg.sigproc.spectral
+   ezmsg.sigproc.spectrogram
+   ezmsg.sigproc.spectrum
+   ezmsg.sigproc.wavelets
+   ezmsg.sigproc.bandpower
+   ezmsg.sigproc.fbcca
+
+Sampling & Resampling
+---------------------
+
+Signal sampling, windowing, and resampling operations.
+
+.. autosummary::
+   :toctree: generated
+   :recursive:
+
+   ezmsg.sigproc.sampler
+   ezmsg.sigproc.window
+   ezmsg.sigproc.resample
+   ezmsg.sigproc.downsample
+   ezmsg.sigproc.decimate
+
+Signal Conditioning
+-------------------
+
+Signal preprocessing and conditioning operations.
+
+.. autosummary::
+   :toctree: generated
+   :recursive:
+
+   ezmsg.sigproc.scaler
+   ezmsg.sigproc.detrend
+   ezmsg.sigproc.activation
+   ezmsg.sigproc.quantize
+   ezmsg.sigproc.ewma
+
+Transformations
+---------------
+
+Geometric and structural transformations.
+
+.. autosummary::
+   :toctree: generated
+   :recursive:
+
+   ezmsg.sigproc.affinetransform
+   ezmsg.sigproc.transpose
+   ezmsg.sigproc.extract_axis
+   ezmsg.sigproc.slicer
+
+Signal Operations
+-----------------
+
+Aggregation, difference, and other signal operations.
+
+.. autosummary::
+   :toctree: generated
+   :recursive:
+
+   ezmsg.sigproc.aggregate
+   ezmsg.sigproc.diff
+
+Signal Generation
+-----------------
+
+Synthetic signal generators and injectors.
+
+.. autosummary::
+   :toctree: generated
+   :recursive:
+
+   ezmsg.sigproc.synth
+   ezmsg.sigproc.signalinjector
+
+Messages & Data Structures
+---------------------------
+
+Message types and data structures.
+
+.. autosummary::
+   :toctree: generated
+   :recursive:
+
+   ezmsg.sigproc.messages
+
+Math Utilities
+--------------
+
+Mathematical operations on signals.
+
+.. autosummary::
+   :toctree: generated
+   :recursive:
+
+   ezmsg.sigproc.math
+
+Utilities
+---------
+
+Helper utilities for signal processing.
+
+.. autosummary::
+   :toctree: generated
+   :recursive:
+
+   ezmsg.sigproc.util