mujoco/.readthedocs.yml at main · AYUSHMIT/mujoco · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

version: 2

# TODO(robotics-simulation): pdf format fails to build on readthedocs
# formats:
#   - pdf

build:
  os: ubuntu-24.04
  tools:
    python: "3.12"
  apt_packages:
    - libgl-dev
  jobs:
    create_environment:
      # install uv
      - asdf plugin add uv
      - asdf install uv latest
      - asdf global uv latest
      - uv venv $READTHEDOCS_VIRTUALENV_PATH
      # install doc requirements
      - |
        UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH \
        uv pip install \
          -r doc/requirements.txt \
          pip setuptools absl-py
      # generate and install doc-only mujoco stubs (no C build required)
      - python doc/make_mujoco_stubs.py python/mujoco_doc
      - |
        UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH \
        uv pip install --no-deps python/mujoco_doc
      # install mjx and mujoco_warp (mujoco dep satisfied by stubs above)
      - UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv pip install -e mjx
      - |
        find mjx/mujoco/mjx/third_party/mujoco_warp -type f -exec \
          sed -i 's/mujoco\.mjx\.third_party\.mujoco_warp/mujoco_warp/g' {} \;
      - python doc/mjwarp/update_types.py mjx/mujoco/mjx/third_party/mujoco_warp/_src/types.py
      - |
        UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH \
        uv pip install mjx/mujoco/mjx/third_party/mujoco_warp
    install:
      - "true"  # skip default install

sphinx:
  builder: html
  configuration: doc/conf.py
  fail_on_warning: false