Library for communicating with Opensensorhub that provides options for saving configurations, getting visualization recommendations for data, retrieving data in real time, archival streams, and batch modes, and more.
API Documentation available here
Links:
The documentation is built with MkDocs using the
Material theme, mkdocstrings for
auto-generated API reference from the source, and
mermaid for architecture diagrams. Markdown sources
live under docs/markdown/.
Install dev dependencies (including MkDocs and plugins):
uv syncBuild the HTML docs:
uv run mkdocs buildThe output will be in docs/build/html/. Open docs/build/html/index.html in
a browser to view locally.
For a live-reloading preview while editing:
uv run mkdocs serveThen visit http://127.0.0.1:8000.
To match what CI publishes (warnings become errors — useful when you've touched docstrings):
uv run mkdocs build --strictCI builds the site on every push and deploys main to GitHub Pages via
.github/workflows/docs_pages.yaml.
The legacy Sphinx setup under docs/source/ is kept temporarily for
reference and builds to a separate output directory:
uv run sphinx-build -b html docs/source docs/build/sphinx