Update .readthedocs.yml to install MuJoCo Warp in order to generate API documentation. Additionally, mirror mujoco_warp/pyproject.toml in mjx/mujoco/mjx/third_party/mujoco_warp.

PiperOrigin-RevId: 814656860
Change-Id: Ie4c0e9076c90b598dedc65a3e9793ed3d2375c37

.readthedocs.yml

@@ -8,6 +8,16 @@ build:
   tools:
     python: "3.10"
 
+  # install mujoco warp to generate api documentation
+  jobs:
+    post_install:
+      - pip install uv
+      - mkdir -p /tmp/mujoco_warp
+      - cp -r mjx/mujoco/mjx/third_party/mujoco_warp/ /tmp/mujoco_warp/
+      - cd /tmp/mujoco_warp
+      - mv mujoco_warp/pyproject.toml .
+      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH uv pip install -e .
+
 sphinx:
   builder: html
   configuration: doc/conf.py

doc/programming/index.rst

@@ -135,6 +135,8 @@ If you wish to build the documentation locally, for example to test pull-request
 1. Clone the ``mujoco`` repository: ``git clone https://github.com/deepmind/mujoco.git``
 2. Go to the ``doc/`` directory: ``cd mujoco/doc``
 3. Install the dependencies: ``pip install -r requirements.txt``
+   |br| Note that the MuJoCo Warp API documentation is autogenerated and requires additional dependencies.
+   See `.readthedocs.yml <https://github.com/google-deepmind/mujoco/blob/main/.readthedocs.yml>`__ for details.
 4. Build the HTML: ``make html``
 5. Open ``_build/html/index.html`` in your browser of choice.
 

mjx/mujoco/mjx/third_party/mujoco_warp/pyproject.toml

@@ -0,0 +1,104 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name="mujoco-warp"
+version = "0.0.1"
+# TODO(team): create a distribution list
+authors = [
+    {name = "Newton Developers", email = "mujoco@deepmind.com"},
+]
+description = "MuJoCo Warp (MJWarp)"
+readme = {file = "README.md", content-type = "text/markdown"}
+license = "Apache-2.0"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering",
+]
+requires-python = ">=3.9"
+dependencies = [
+    "absl-py",
+    "etils[epath]",
+    "mujoco>=3.3.6.dev802089588",
+    "numpy",
+    "warp-lang>=1.9.0.dev20250825",
+]
+
+[[tool.uv.index]]
+name = "nvidia"
+url = "https://pypi.nvidia.com"
+explicit = true
+
+[[tool.uv.index]]
+name = "mujoco"
+url = "https://py.mujoco.org/"
+explicit = true
+
+[tool.uv.sources]
+warp-lang = {index = "nvidia"}
+mujoco = {index = "mujoco"}
+
+[project.optional-dependencies]
+dev = [
+    "pre-commit",
+    "pytest",
+    "pytest-xdist",
+    "ruff",
+    "pygls>=1.0.0,<2.0.0",
+    "lsprotocol>=2023.0.1,<2024.0.0",
+]
+# TODO(team): cpu and cuda JAX optional dependencies are temporary, remove after we land MJX:Warp
+cpu = [
+    "jax"
+]
+cuda = [
+    "jax[cuda12]"
+]
+
+[project.scripts]
+mjwarp-testspeed = "mujoco_warp.testspeed:main"
+mjwarp-viewer = "mujoco_warp.viewer:main"
+
+[project.urls]
+Homepage = "https://github.com/google-deepmind/mujoco_warp"
+Documentation = "https://mujoco.readthedocs.io"
+Repository = "https://github.com/google-deepmind/mujoco_warp"
+Changelog = "https://mujoco.readthedocs.io/en/stable/changelog.html"
+
+[tool.ruff]
+line-length = 128
+indent-width = 2
+extend-exclude = ["*.ipynb"]
+
+[tool.ruff.lint]
+select = [
+    "I",  # isort
+    "W",  # pycodestyle
+]
+
+[tool.ruff.lint.isort]
+force-single-line = true
+single-line-exclusions = ["typing"]
+
+[tool.ruff.lint.pycodestyle]
+max-doc-length = 100
+max-line-length = 128
+
+[tool.ruff.format]
+docstring-code-format = true
+docstring-code-line-length = 100
+
+[tool.setuptools]
+package-data = { "mujoco_warp" = ["test_data/**"] }
+
+[tool.setuptools.packages.find]
+include = ["mujoco_warp*"]