Config Reference Demo

This page demonstrates mkdocs-terok's config-reference generators using a space-weather-station Pydantic model — StationConfig.

Field Reference Tables

Top-level keys

Key	Type	Default	Description
station_id	string	"SWS-07"	Broadcast identifier used in telemetry headers.
region	string or null	—	Heliospheric sector this station is responsible for.
polling_interval	number	5.0	How often sensors sample, in seconds.
active	boolean	true	Set to false to put the station in standby mode.
watch_bands	list of string	[]	Spectral bands the station actively monitors.

solar_sensors:

Key	Type	Default	Description
flux_threshold	number	120.0	Alert fires when solar flux exceeds this value in SFU.
particle_detectors	integer	8	Number of detector modules installed.
auto_alert	boolean	true	When enabled, threshold breaches trigger automatic alerts.

Annotated YAML Example

# Broadcast identifier used in telemetry headers.
station_id: SWS-07
# Heliospheric sector this station is responsible for.
region:
# How often sensors sample, in seconds.
polling_interval: 5.0
# Set to false to put the station in standby mode.
active: true
# Spectral bands the station actively monitors.
watch_bands: []
# Configuration for the onboard solar sensor array.
solar_sensors:
  # Alert fires when solar flux exceeds this value in SFU.
  flux_threshold: 120.0
  # Number of detector modules installed.
  particle_detectors: 8
  # When enabled, threshold breaches trigger automatic alerts.
  auto_alert: true

JSON Schema

Full JSON Schema

{
  "$defs": {
    "SolarSensors": {
      "description": "Solar activity monitoring sensor array.",
      "properties": {
        "flux_threshold": {
          "default": 120.0,
          "description": "Solar flux alert threshold (SFU)",
          "title": "Flux Threshold",
          "type": "number"
        },
        "particle_detectors": {
          "default": 8,
          "description": "Active particle detector count",
          "title": "Particle Detectors",
          "type": "integer"
        },
        "auto_alert": {
          "default": true,
          "description": "Emit alerts on threshold breach",
          "title": "Auto Alert",
          "type": "boolean"
        }
      },
      "title": "SolarSensors",
      "type": "object"
    }
  },
  "description": "Configuration for a space weather monitoring station.",
  "properties": {
    "station_id": {
      "default": "SWS-07",
      "description": "Unique station identifier",
      "title": "Station Id",
      "type": "string"
    },
    "region": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Assigned monitoring region",
      "title": "Region"
    },
    "polling_interval": {
      "default": 5.0,
      "description": "Sensor polling interval (seconds)",
      "title": "Polling Interval",
      "type": "number"
    },
    "active": {
      "default": true,
      "description": "Station operational status",
      "title": "Active",
      "type": "boolean"
    },
    "watch_bands": {
      "description": "Electromagnetic bands under observation",
      "items": {
        "type": "string"
      },
      "title": "Watch Bands",
      "type": "array"
    },
    "solar_sensors": {
      "$ref": "#/$defs/SolarSensors"
    }
  },
  "title": "StationConfig",
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}