Development¶
This page collects the maintenance workflow for UniEnvPy.
Local Setup¶
From the UniEnvPy directory:
Install backend- or integration-specific dependencies separately if you are working on those areas.
Documentation Generation¶
The docs site combines:
- hand-written pages under
docs/ - generated API pages created by
docs/gen_ref_pages.py
The generation step walks the unienv_interface and unienv_data modules and emits reference pages consumed by mkdocstrings.
The look comes from the shared UniEnv docs theme, which lives in docs-theme/ of
UniEnvOrg.github.io. Fetch it once, then serve:
pip install -e ".[docs]"
scripts/fetch_docs_theme.sh # or: scripts/fetch_docs_theme.sh ../UniEnvOrg.github.io
mkdocs serve
Published versions¶
The site is versioned with mike on the gh-pages branch,
by the Deploy Docs workflow:
| Trigger | Published at |
|---|---|
push to main |
/UniEnv/dev/ |
GitHub release X |
/UniEnv/X/, also aliased as /UniEnv/latest/ (the default) |
| manual run with a version | that version, optionally made latest |
Links from before versioning (/UniEnv/concepts/...) are redirected to the same page under latest/.
What To Keep Stable¶
For release-facing docs, the most important guarantees to keep visible are:
- the distinction between
unienv_interfaceandunienv_data - the difference between
EnvandFuncEnv - the role of
Spaceas the schema contract across runtime and storage code - the storage-backed nature of replay buffers
- the world/node composition model for richer environments
Before A Release¶
Check at least the following:
README.mdreflects the current package layout and installation story.- The docs landing page matches the actual module boundaries.
mkdocs buildsucceeds without broken references.- Tests covering wrappers, spaces, transformations, and replay buffers still pass.