mujorax 0.1.0__tar.gz

mujorax-0.1.0/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @achronus

mujorax-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,41 @@
+name: Mkdocs Build
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    name: Deploy MkDocs to GitHub Pages
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v8.1.0
+        with:
+          python-version: "3.13"
+          enable-cache: true
+
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+
+      - uses: actions/cache@v5
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+
+      - name: Install dependencies
+        run: uv sync --group docs
+
+      - name: Deploy MkDocs
+        run: uv run mkdocs gh-deploy --force

mujorax-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,45 @@
+name: Publish to PyPI
+
+on:
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: "Release tag to publish (e.g. v0.1.0)"
+        required: true
+        type: string
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          ref: ${{ inputs.tag }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v8.1.0
+        with:
+          python-version: "3.13"
+          enable-cache: true
+
+      - name: Build package
+        run: uv build
+
+      - name: Verify artifacts
+        run: |
+          if [ -z "$(ls dist/*.whl 2>/dev/null)" ]; then
+            echo "ERROR: No wheel found in dist/"
+            exit 1
+          fi
+          echo "Built artifacts:"
+          ls -la dist/
+
+      - name: Publish to PyPI
+        run: uv publish
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_API_TOKEN }}

mujorax-0.1.0/.gitignore

@@ -0,0 +1,219 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+.jax_cache/
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

mujorax-0.1.0/.python-version

@@ -0,0 +1 @@
+3.13.9

mujorax-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Achronus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mujorax-0.1.0/PKG-INFO

@@ -0,0 +1,149 @@
+Metadata-Version: 2.4
+Name: mujorax
+Version: 0.1.0
+Summary: A JAX-native MuJoCo environment suite for Envrax.
+Project-URL: Homepage, https://github.com/Achronus/mujorax
+Project-URL: Documentation, https://mujorax.achronus.dev/
+Project-URL: Repository, https://github.com/Achronus/mujorax
+Author-email: Ryan Partridge <codemonkey37@proton.me>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: <4.0,>=3.13
+Requires-Dist: envrax==0.1.5
+Requires-Dist: playground>=0.2.0
+Description-Content-Type: text/markdown
+
+![Logo](https://raw.githubusercontent.com/Achronus/mujorax/main/docs/assets/imgs/main.png)
+
+![Python Version](https://img.shields.io/pypi/pyversions/mujorax)
+![License](https://img.shields.io/github/license/Achronus/mujorax)
+
+Mujorax is a lightweight open-source JAX-native MuJoCo environment suite for single-agent Reinforcement Learning (RL), built on top of [Envrax](https://github.com/Achronus/envrax). It wraps [MuJoCo Playground](https://github.com/google-deepmind/mujoco_playground) environments with Envrax's `JaxEnv` so you can use them with `envrax.make`, `envrax.make_vec`, and the rest of Envrax's tooling.
+
+It comes with __25 environments from the DM Control Suite__. All environment logic follows a *stateless functional design* that builds on top of the [MJX](https://github.com/google-deepmind/mujoco), [JAX](https://github.com/jax-ml/jax), and [Chex](https://github.com/google-deepmind/chex) packages to benefit from JAX accelerator efficiency.
+
+## Why Mujorax?
+
+[Envrax](https://github.com/Achronus/envrax) provides a JAX-native [Gymnasium-style](https://gymnasium.farama.org/) API standard for RL environments, but it doesn't ship with any environments of its own. One of the biggest spaces in RL is robotics, and the gold-standard physics engine for this is [MuJoCo](https://github.com/google-deepmind/mujoco). This makes it the perfect fit for one of the first Envrax environment suites!
+
+[MuJoCo Playground](https://github.com/google-deepmind/mujoco_playground) is Google DeepMind's open-source library of MuJoCo environments, built on top of [MJX](https://github.com/google-deepmind/mujoco) (MuJoCo's JAX port that preserves the simulator's full physics fidelity). It already solves the hard parts: research-validated reward and termination logic for DM Control, locomotion, and manipulation environments. The only catch is that its environments expose a Brax-style `MjxEnv` API, which doesn't quite fit Envrax's API standard.
+
+Rather than reinventing the wheel, Mujorax acts as a thin, type-safe wrapper around the MuJoCo Playground environments to maximise their benefits while maintaining Envrax's API standard, making it completely plug-and-play with Envrax's toolkit.
+
+## Requirements
+
+- Python 3.13+
+- JAX 0.9+ (CPU, CUDA, or TPU backend)
+
+## Installation
+
+```bash
+pip install mujorax
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add mujorax
+```
+
+## Quick Start
+
+```python
+import jax
+import mujorax  # registers the suite at import
+import envrax
+
+env = envrax.make("mjx/cartpole_balance-v0")
+obs, state = env.reset(jax.random.PRNGKey(0))
+
+action = env.action_space.sample(jax.random.PRNGKey(1))
+obs, state, reward, done, info = env.step(state, action)
+```
+
+Vectorised rollouts work the same way:
+
+```python
+env = envrax.make_vec("mjx/cartpole_balance-v0", n_envs=128)
+obs, state = env.reset(jax.random.PRNGKey(0))  # obs.shape == (128, 5)
+```
+
+You can also use `make_multi` to utilise several heterogeneous environments at once:
+
+```python
+env = envrax.make_multi([
+    "mjx/cartpole_balance-v0",
+    "mjx/cheetah_run-v0",
+])
+obs_list, state_list = env.reset(jax.random.PRNGKey(0))  # one entry per env
+```
+
+Or, the `make_multi_vec` method for vectorised parallel copies of each environment:
+
+```python
+env = envrax.make_multi_vec(
+    ["mjx/cartpole_balance-v0", "mjx/cheetah_run-v0"],
+    n_envs=64,
+)
+obs_list, state_list = env.reset(jax.random.PRNGKey(0))
+# each entries obs.shape == (64, *single_obs.shape)
+```
+
+Mujorax auto-detects whether a CUDA backend is available; on CPU-only systems it transparently falls back to MJX's pure-JAX physics implementation.
+
+You can override this choice through this `MjxPlaygroundConfig(config_overrides={"impl": ...})` if needed.
+
+## Environments
+
+All environments share canonical IDs in the form `mjx/<name>-v0`. Here's the full list of supported environments:
+
+| Canonical ID | Description |
+| --- | --- |
+| `mjx/acrobot_swingup-v0` | Two-link underactuated pendulum; dense reward for swinging the tip to target |
+| `mjx/acrobot_swingup_sparse-v0` | Same as `acrobot_swingup` with a sparse (binary) reward |
+| `mjx/ball_in_cup-v0` | Planar ball-and-cup catching task; sparse reward when caught |
+| `mjx/cartpole_balance-v0` | Cart starts near upright; dense reward for keeping the pole upright |
+| `mjx/cartpole_balance_sparse-v0` | Same as `cartpole_balance` with a sparse reward |
+| `mjx/cartpole_swingup-v0` | Cart starts hanging; dense reward for swinging up and balancing |
+| `mjx/cartpole_swingup_sparse-v0` | Same as `cartpole_swingup` with a sparse reward |
+| `mjx/cheetah_run-v0` | Planar bipedal cheetah; dense reward proportional to forward speed |
+| `mjx/finger_spin-v0` | Two-DoF finger spinning a free body; dense reward for angular velocity |
+| `mjx/finger_turn_easy-v0` | Two-DoF finger rotating a body to a target with large tolerance |
+| `mjx/finger_turn_hard-v0` | Same as `finger_turn_easy` with a tighter tolerance |
+| `mjx/fish_swim-v0` | 3D free-swimming fish; dense reward for swimming to a randomised target |
+| `mjx/hopper_hop-v0` | One-legged planar hopper; dense reward for forward speed |
+| `mjx/hopper_stand-v0` | One-legged hopper; dense reward for standing upright |
+| `mjx/humanoid_run-v0` | 21-DoF humanoid; dense reward for matching a running speed |
+| `mjx/humanoid_stand-v0` | 21-DoF humanoid; dense reward for standing upright |
+| `mjx/humanoid_walk-v0` | 21-DoF humanoid; dense reward for matching a walking speed |
+| `mjx/pendulum_swingup-v0` | Single-link pendulum; dense reward for swinging up and balancing |
+| `mjx/point_mass-v0` | Planar point mass actuated in 2D; dense reward to a randomised target |
+| `mjx/reacher_easy-v0` | Two-link planar arm reaching a large target |
+| `mjx/reacher_hard-v0` | Same as `reacher_easy` with a smaller target |
+| `mjx/swimmer_swimmer6-v0` | Six-link planar swimmer; dense reward for the head reaching a target |
+| `mjx/walker_run-v0` | Planar bipedal walker; dense reward for running speed |
+| `mjx/walker_stand-v0` | Planar bipedal walker; dense reward for standing upright |
+| `mjx/walker_walk-v0` | Planar bipedal walker; dense reward for walking speed |
+
+## Acknowledgements
+
+Mujorax wouldn't be possible without these incredible projects:
+
+- [MuJoCo Playground](https://github.com/google-deepmind/mujoco_playground) — the underlying environment implementations.
+- [MuJoCo](https://github.com/google-deepmind/mujoco) and [MJX](https://github.com/google-deepmind/mujoco) — the physics engine and JAX bindings.
+- [Envrax](https://github.com/Achronus/envrax) — the registry and base environment API standard.
+
+❤️ Thank you to all the developers involved - you guys are awesome! ❤️

mujorax-0.1.0/README.md

@@ -0,0 +1,121 @@
+![Logo](https://raw.githubusercontent.com/Achronus/mujorax/main/docs/assets/imgs/main.png)
+
+![Python Version](https://img.shields.io/pypi/pyversions/mujorax)
+![License](https://img.shields.io/github/license/Achronus/mujorax)
+
+Mujorax is a lightweight open-source JAX-native MuJoCo environment suite for single-agent Reinforcement Learning (RL), built on top of [Envrax](https://github.com/Achronus/envrax). It wraps [MuJoCo Playground](https://github.com/google-deepmind/mujoco_playground) environments with Envrax's `JaxEnv` so you can use them with `envrax.make`, `envrax.make_vec`, and the rest of Envrax's tooling.
+
+It comes with __25 environments from the DM Control Suite__. All environment logic follows a *stateless functional design* that builds on top of the [MJX](https://github.com/google-deepmind/mujoco), [JAX](https://github.com/jax-ml/jax), and [Chex](https://github.com/google-deepmind/chex) packages to benefit from JAX accelerator efficiency.
+
+## Why Mujorax?
+
+[Envrax](https://github.com/Achronus/envrax) provides a JAX-native [Gymnasium-style](https://gymnasium.farama.org/) API standard for RL environments, but it doesn't ship with any environments of its own. One of the biggest spaces in RL is robotics, and the gold-standard physics engine for this is [MuJoCo](https://github.com/google-deepmind/mujoco). This makes it the perfect fit for one of the first Envrax environment suites!
+
+[MuJoCo Playground](https://github.com/google-deepmind/mujoco_playground) is Google DeepMind's open-source library of MuJoCo environments, built on top of [MJX](https://github.com/google-deepmind/mujoco) (MuJoCo's JAX port that preserves the simulator's full physics fidelity). It already solves the hard parts: research-validated reward and termination logic for DM Control, locomotion, and manipulation environments. The only catch is that its environments expose a Brax-style `MjxEnv` API, which doesn't quite fit Envrax's API standard.
+
+Rather than reinventing the wheel, Mujorax acts as a thin, type-safe wrapper around the MuJoCo Playground environments to maximise their benefits while maintaining Envrax's API standard, making it completely plug-and-play with Envrax's toolkit.
+
+## Requirements
+
+- Python 3.13+
+- JAX 0.9+ (CPU, CUDA, or TPU backend)
+
+## Installation
+
+```bash
+pip install mujorax
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add mujorax
+```
+
+## Quick Start
+
+```python
+import jax
+import mujorax  # registers the suite at import
+import envrax
+
+env = envrax.make("mjx/cartpole_balance-v0")
+obs, state = env.reset(jax.random.PRNGKey(0))
+
+action = env.action_space.sample(jax.random.PRNGKey(1))
+obs, state, reward, done, info = env.step(state, action)
+```
+
+Vectorised rollouts work the same way:
+
+```python
+env = envrax.make_vec("mjx/cartpole_balance-v0", n_envs=128)
+obs, state = env.reset(jax.random.PRNGKey(0))  # obs.shape == (128, 5)
+```
+
+You can also use `make_multi` to utilise several heterogeneous environments at once:
+
+```python
+env = envrax.make_multi([
+    "mjx/cartpole_balance-v0",
+    "mjx/cheetah_run-v0",
+])
+obs_list, state_list = env.reset(jax.random.PRNGKey(0))  # one entry per env
+```
+
+Or, the `make_multi_vec` method for vectorised parallel copies of each environment:
+
+```python
+env = envrax.make_multi_vec(
+    ["mjx/cartpole_balance-v0", "mjx/cheetah_run-v0"],
+    n_envs=64,
+)
+obs_list, state_list = env.reset(jax.random.PRNGKey(0))
+# each entries obs.shape == (64, *single_obs.shape)
+```
+
+Mujorax auto-detects whether a CUDA backend is available; on CPU-only systems it transparently falls back to MJX's pure-JAX physics implementation.
+
+You can override this choice through this `MjxPlaygroundConfig(config_overrides={"impl": ...})` if needed.
+
+## Environments
+
+All environments share canonical IDs in the form `mjx/<name>-v0`. Here's the full list of supported environments:
+
+| Canonical ID | Description |
+| --- | --- |
+| `mjx/acrobot_swingup-v0` | Two-link underactuated pendulum; dense reward for swinging the tip to target |
+| `mjx/acrobot_swingup_sparse-v0` | Same as `acrobot_swingup` with a sparse (binary) reward |
+| `mjx/ball_in_cup-v0` | Planar ball-and-cup catching task; sparse reward when caught |
+| `mjx/cartpole_balance-v0` | Cart starts near upright; dense reward for keeping the pole upright |
+| `mjx/cartpole_balance_sparse-v0` | Same as `cartpole_balance` with a sparse reward |
+| `mjx/cartpole_swingup-v0` | Cart starts hanging; dense reward for swinging up and balancing |
+| `mjx/cartpole_swingup_sparse-v0` | Same as `cartpole_swingup` with a sparse reward |
+| `mjx/cheetah_run-v0` | Planar bipedal cheetah; dense reward proportional to forward speed |
+| `mjx/finger_spin-v0` | Two-DoF finger spinning a free body; dense reward for angular velocity |
+| `mjx/finger_turn_easy-v0` | Two-DoF finger rotating a body to a target with large tolerance |
+| `mjx/finger_turn_hard-v0` | Same as `finger_turn_easy` with a tighter tolerance |
+| `mjx/fish_swim-v0` | 3D free-swimming fish; dense reward for swimming to a randomised target |
+| `mjx/hopper_hop-v0` | One-legged planar hopper; dense reward for forward speed |
+| `mjx/hopper_stand-v0` | One-legged hopper; dense reward for standing upright |
+| `mjx/humanoid_run-v0` | 21-DoF humanoid; dense reward for matching a running speed |
+| `mjx/humanoid_stand-v0` | 21-DoF humanoid; dense reward for standing upright |
+| `mjx/humanoid_walk-v0` | 21-DoF humanoid; dense reward for matching a walking speed |
+| `mjx/pendulum_swingup-v0` | Single-link pendulum; dense reward for swinging up and balancing |
+| `mjx/point_mass-v0` | Planar point mass actuated in 2D; dense reward to a randomised target |
+| `mjx/reacher_easy-v0` | Two-link planar arm reaching a large target |
+| `mjx/reacher_hard-v0` | Same as `reacher_easy` with a smaller target |
+| `mjx/swimmer_swimmer6-v0` | Six-link planar swimmer; dense reward for the head reaching a target |
+| `mjx/walker_run-v0` | Planar bipedal walker; dense reward for running speed |
+| `mjx/walker_stand-v0` | Planar bipedal walker; dense reward for standing upright |
+| `mjx/walker_walk-v0` | Planar bipedal walker; dense reward for walking speed |
+
+## Acknowledgements
+
+Mujorax wouldn't be possible without these incredible projects:
+
+- [MuJoCo Playground](https://github.com/google-deepmind/mujoco_playground) — the underlying environment implementations.
+- [MuJoCo](https://github.com/google-deepmind/mujoco) and [MJX](https://github.com/google-deepmind/mujoco) — the physics engine and JAX bindings.
+- [Envrax](https://github.com/Achronus/envrax) — the registry and base environment API standard.
+
+❤️ Thank you to all the developers involved - you guys are awesome! ❤️

mujorax-0.1.0/docs/CNAME

@@ -0,0 +1 @@
+mujorax.achronus.dev

mujorax-0.1.0/docs/_extensions/docstring_polish.py

@@ -0,0 +1,70 @@
+"""Griffe extension that polishes numpy-style docstrings for mkdocstrings rendering.
+
+Two transforms are applied at the source / parsed-section level so the rest of
+mkdocstrings's pipeline (cross-references, inventories, default templates)
+just works on the result.
+
+1. Strip trailing ` (optional)` from parameter type lines. The project writes
+   optional parameters as `name : Type (optional)`; griffe's numpy parser only
+   strips `, optional`, so without this the annotation ends up parsed as a
+   Python call `Type(optional)` which renders verbatim. The `Default` column
+   already conveys optionality.
+
+2. Split Raises entries of the form `name : ExceptionType` into a real `name`
+   attribute plus a typed `annotation` expression. Griffe's numpy parser only
+   recognises bare exception types (`ExceptionType`) — the `name :` prefix
+   makes it leave the whole line as a raw string, which blocks cross-reference
+   resolution (e.g. linking `ValueError` to python.org). After this transform
+   the custom `raises.html.jinja` template can render the type via the
+   standard expression pipeline and get autoref'd inventory links for free.
+"""
+
+from __future__ import annotations
+
+import re
+
+import griffe
+from griffe._internal.docstrings.utils import parse_docstring_annotation
+
+
+_OPTIONAL_RE = re.compile(r"^(?P<prefix>\s*\w[\w\d_]*\s*:\s*.+?)\s*\(optional\)\s*$", re.MULTILINE)
+
+
+def _strip_optional(text: str | None) -> str | None:
+    if not text or "(optional)" not in text:
+        return text
+    return _OPTIONAL_RE.sub(r"\g<prefix>", text)
+
+
+def _split_raises(docstring: griffe.Docstring) -> None:
+    for section in docstring.parsed:
+        if section.kind != griffe.DocstringSectionKind.raises:
+            continue
+        for raise_obj in section.value:
+            annot = raise_obj.annotation
+            if not isinstance(annot, str) or " : " not in annot:
+                continue
+            name_str, type_str = annot.split(" : ", 1)
+            raise_obj.name = name_str.strip()
+            raise_obj.annotation = parse_docstring_annotation(type_str.strip(), docstring)
+
+
+class DocstringPolish(griffe.Extension):
+    """Project-specific numpy docstring cleanup for mkdocstrings."""
+
+    def on_instance(
+        self,
+        *,
+        obj: griffe.Object,
+        **_: object,
+    ) -> None:
+        doc = obj.docstring
+        if doc is None:
+            return
+
+        cleaned = _strip_optional(doc.value)
+        if cleaned is not None and cleaned != doc.value:
+            doc.value = cleaned
+            doc.__dict__.pop("parsed", None)
+
+        _split_raises(doc)