Docs cleanup

.github/workflows/docs.yml

@@ -0,0 +1,26 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: pip install -e .[docs]
+
+      - name: Deploy to GitHub Pages
+        run: mkdocs gh-deploy --force

.github/workflows/publish.yml

@@ -0,0 +1,46 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # needed for setuptools_scm
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

README.md

@@ -3,16 +3,13 @@
 </div>
 
 # ORC: Open Reservoir Computing
-### Warning: ORC is currently under development, many things may be (are definitely) broken and not all functionality is documented
 [![CI](https://github.com/Jan-Williams/OpenReservoirComputing/actions/workflows/tests.yml/badge.svg)](https://github.com/Jan-Williams/OpenReservoirComputing/actions/workflows/tests.yml)
 [![codecov](https://codecov.io/gh/Jan-Williams/OpenReservoirComputing/branch/main/graph/badge.svg)](https://codecov.io/gh/Jan-Williams/OpenReservoirComputing)
 
 
 ORC is the one-stop-shop for performant reservoir computing in jax. Key high-level features include
 - Modular design for mixing and matching layers and reservoir drivers (or creating your own!)
 - Continuous, discrete, serial, and parallel implementations
-- Built in hyperparameter tuning (coming soon!)
-- Multi-gpu training and inference (coming soon!)
 
 ## Installation
 

docs/api/classifier.md

@@ -0,0 +1,26 @@
+# Classifier API Reference
+
+The `orc.classifier` subpackage provides reservoir computing models for time series classification.
+
+## Base Classes
+
+::: orc.classifier.base.RCClassifierBase
+    options:
+      show_root_heading: true
+      show_source: true
+      members_order: source
+
+## Models
+
+::: orc.classifier.models.ESNClassifier
+    options:
+      show_root_heading: true
+      show_source: true
+      members_order: source
+
+## Training Functions
+
+::: orc.classifier.train.train_ESNClassifier
+    options:
+      show_root_heading: true
+      show_source: true

docs/api/control.md

@@ -0,0 +1,26 @@
+# Control API Reference
+
+The `orc.control` subpackage provides reservoir computing models for dynamical system control.
+
+## Base Classes
+
+::: orc.control.base.RCControllerBase
+    options:
+      show_root_heading: true
+      show_source: true
+      members_order: source
+
+## Models
+
+::: orc.control.models.ESNController
+    options:
+      show_root_heading: true
+      show_source: true
+      members_order: source
+
+## Training Functions
+
+::: orc.control.train.train_ESNController
+    options:
+      show_root_heading: true
+      show_source: true

docs/api/forecaster.md

@@ -0,0 +1,54 @@
+# Forecaster API Reference
+
+The `orc.forecaster` subpackage provides reservoir computing models for time series forecasting.
+
+## Base Classes
+
+::: orc.forecaster.base.RCForecasterBase
+    options:
+      show_root_heading: true
+      show_source: true
+      members_order: source
+
+::: orc.forecaster.base.CRCForecasterBase
+    options:
+      show_root_heading: true
+      show_source: true
+      members_order: source
+
+## Models
+
+::: orc.forecaster.models.ESNForecaster
+    options:
+      show_root_heading: true
+      show_source: true
+      members_order: source
+
+::: orc.forecaster.models.CESNForecaster
+    options:
+      show_root_heading: true
+      show_source: true
+      members_order: source
+
+::: orc.forecaster.models.EnsembleESNForecaster
+    options:
+      show_root_heading: true
+      show_source: true
+      members_order: source
+
+## Training Functions
+
+::: orc.forecaster.train.train_ESNForecaster
+    options:
+      show_root_heading: true
+      show_source: true
+
+::: orc.forecaster.train.train_CESNForecaster
+    options:
+      show_root_heading: true
+      show_source: true
+
+::: orc.forecaster.train.train_EnsembleESNForecaster
+    options:
+      show_root_heading: true
+      show_source: true