mkdocs.yml

site_name: Unreal Robotics Lab
site_description: MuJoCo physics simulation plugin for Unreal Engine. Guides, API reference, and technical documentation.
site_url: https://urlab-sim.github.io/UnrealRoboticsLab/
repo_url: https://github.com/URLab-Sim/UnrealRoboticsLab
repo_name: URLab-Sim/UnrealRoboticsLab

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    - scheme: slate
      primary: black
      accent: blue grey
      toggle:
        icon: material/brightness-7
        name: Switch to light mode
    - scheme: default
      primary: white
      accent: blue grey
      toggle:
        icon: material/brightness-4
        name: Switch to dark mode
  logo: images/logo.png
  favicon: images/logo.png
  font:
    text: Outfit
    code: Fira Code
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - navigation.indexes
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.expand
    - navigation.path
    - navigation.top
    - search.highlight
    - search.suggest
    - content.code.copy
    - content.code.select
    - content.tabs.link
    - toc.follow

plugins:
  - search:
      lang: en
  - tags

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - attr_list
  - md_in_html
  - toc:
      permalink: true
      toc_depth: 3

extra_css:
  - stylesheets/extra.css

# Local scratch/planning notes live in docs/ but are gitignored and never
# published. Exclude them so a local `mkdocs build` stays clean (CI never sees
# them: they are absent from a fresh checkout).
exclude_docs: |
  plan_*.md
  progress_*.md
  local_test_guide.md

nav:
  - Home: index.md
  - Installation: installation.md
  - Quickstart: quickstart.md
  - Guides:
    - Importing Robots: guides/importing.md
    - Articulations: guides/articulations.md
    - Geometry & Collision: guides/geometry.md
    - Sensors & Cameras: guides/sensors_cameras.md
    - Controllers: guides/controllers.md
    - Simulate Dashboard: guides/dashboard.md
    - Debug Visualization: guides/debug.md
    - Interaction: guides/interaction.md
    - Recording & Replay: guides/recording.md
  - Python & External Control:
    - Overview: python/index.md
    - Quickstart: python/quickstart.md
    - Running Policies: python/policies.md
    - API Reference: python/api.md
    - Protocol Reference: reference/protocol.md
  - Concepts:
    - Architecture: concepts/architecture.md
    - Networking: concepts/networking.md
    - Codegen: concepts/codegen.md
    - MJCF Support: concepts/mjcf_support.md
  - Contributing:
    - Building from Source: contributing/building.md
    - Codegen: contributing/codegen.md
    - Bumping MuJoCo: contributing/bumping_mujoco.md
  - Troubleshooting: troubleshooting.md
  - Roadmap: roadmap.md
  - Changelog: changelog.md
  - Contact: contact.md
  # -- AUTO-GENERATED BELOW THIS LINE (do not edit manually) --
  # The C++ API reference under docs/api/ is regenerated by CI from the
  # plugin's .h files. Locally, those files don't exist, so we comment
  # out the nav entries below to keep `mkdocs serve` working. CI restores
  # them on build. To regenerate locally, run the doc-gen script.
  # - API Reference:
  #   - Overview: api/index.md
#     - Core:
#       - EControlSource: api/core/econtrolsource.md
#       - EMjCone: api/core/emjcone.md
#       - EMjIntegrator: api/core/emjintegrator.md
#       - EMjSolver: api/core/emjsolver.md
#       - FMuJoCoDebugData: api/core/fmujocodebugdata.md
#       - FMuJoCoJointState: api/core/fmujocojointstate.md
#       - FMuJoCoOptions: api/core/fmujocooptions.md
#       - FMuJoCoSpatialVelocity: api/core/fmujocospatialvelocity.md
#       - AAMjManager: api/core/aamjmanager.md
#       - AMjArticulation: api/core/amjarticulation.md
#       - UMjSimulationState: api/core/umjsimulationstate.md
#       - Spec:
#         - FMujocoSpecWrapper: api/core/spec/fmujocospecwrapper.md
#         - IMjSpecElement: api/core/spec/imjspecelement.md
#     - Components:
#       - Bodies:
#         - UMjBody: api/components/bodies/umjbody.md
#       - Actuators:
#         - EMjActuatorTrnType: api/components/actuators/emjactuatortrntype.md
#         - EMjActuatorType: api/components/actuators/emjactuatortype.md
#         - UMjActuator: api/components/actuators/umjactuator.md
#         - UMjAdhesionActuator: api/components/actuators/umjadhesionactuator.md
#         - UMjCylinderActuator: api/components/actuators/umjcylinderactuator.md
#         - UMjDamperActuator: api/components/actuators/umjdamperactuator.md
#         - UMjGeneralActuator: api/components/actuators/umjgeneralactuator.md
#         - UMjIntVelocityActuator: api/components/actuators/umjintvelocityactuator.md
#         - UMjMotorActuator: api/components/actuators/umjmotoractuator.md
#         - UMjMuscleActuator: api/components/actuators/umjmuscleactuator.md
#         - UMjPositionActuator: api/components/actuators/umjpositionactuator.md
#         - UMjVelocityActuator: api/components/actuators/umjvelocityactuator.md
#       - Joints:
#         - EMjJointType: api/components/joints/emjjointtype.md
#         - UMjJoint: api/components/joints/umjjoint.md
#         - UMjBallJoint: api/components/joints/umjballjoint.md
#         - UMjFreeJoint: api/components/joints/umjfreejoint.md
#         - UMjHingeJoint: api/components/joints/umjhingejoint.md
#         - UMjSlideJoint: api/components/joints/umjslidejoint.md
#       - Sensors:
#         - EMjObjType: api/components/sensors/emjobjtype.md
#         - EMjSensorType: api/components/sensors/emjsensortype.md
#         - FCameraZmqWorker: api/components/sensors/fcamerazmqworker.md
#         - UMjCamera: api/components/sensors/umjcamera.md
#         - UMjSensor: api/components/sensors/umjsensor.md
#         - UMjAccelerometer: api/components/sensors/umjaccelerometer.md
#         - UMjActuatorFrcSensor: api/components/sensors/umjactuatorfrcsensor.md
#         - UMjActuatorPosSensor: api/components/sensors/umjactuatorpossensor.md
#         - UMjActuatorVelSensor: api/components/sensors/umjactuatorvelsensor.md
#         - UMjBallAngVelSensor: api/components/sensors/umjballangvelsensor.md
#         - UMjBallQuatSensor: api/components/sensors/umjballquatsensor.md
#         - UMjCamProjectionSensor: api/components/sensors/umjcamprojectionsensor.md
#         - UMjClockSensor: api/components/sensors/umjclocksensor.md
#         - UMjContactSensor: api/components/sensors/umjcontactsensor.md
#         - UMjEKineticSensor: api/components/sensors/umjekineticsensor.md
#         - UMjEPotentialSensor: api/components/sensors/umjepotentialsensor.md
#         - UMjForceSensor: api/components/sensors/umjforcesensor.md
#         - UMjFrameAngAccSensor: api/components/sensors/umjframeangaccsensor.md
#         - UMjFrameAngVelSensor: api/components/sensors/umjframeangvelsensor.md
#         - UMjFrameLinAccSensor: api/components/sensors/umjframelinaccsensor.md
#         - UMjFrameLinVelSensor: api/components/sensors/umjframelinvelsensor.md
#         - UMjFramePosSensor: api/components/sensors/umjframepossensor.md
#         - UMjFrameQuatSensor: api/components/sensors/umjframequatsensor.md
#         - UMjFrameXAxisSensor: api/components/sensors/umjframexaxissensor.md
#         - UMjFrameYAxisSensor: api/components/sensors/umjframeyaxissensor.md
#         - UMjFrameZAxisSensor: api/components/sensors/umjframezaxissensor.md
#         - UMjGeomDistSensor: api/components/sensors/umjgeomdistsensor.md
#         - UMjGeomFromToSensor: api/components/sensors/umjgeomfromtosensor.md
#         - UMjGeomNormalSensor: api/components/sensors/umjgeomnormalsensor.md
#         - UMjGyro: api/components/sensors/umjgyro.md
#         - UMjInsideSiteSensor: api/components/sensors/umjinsidesitesensor.md
#         - UMjJointActFrcSensor: api/components/sensors/umjjointactfrcsensor.md
#         - UMjJointLimitFrcSensor: api/components/sensors/umjjointlimitfrcsensor.md
#         - UMjJointLimitPosSensor: api/components/sensors/umjjointlimitpossensor.md
#         - UMjJointLimitVelSensor: api/components/sensors/umjjointlimitvelsensor.md
#         - UMjJointPosSensor: api/components/sensors/umjjointpossensor.md
#         - UMjJointVelSensor: api/components/sensors/umjjointvelsensor.md
#         - UMjMagnetometer: api/components/sensors/umjmagnetometer.md
#         - UMjRangeFinderSensor: api/components/sensors/umjrangefindersensor.md
#         - UMjSubtreeAngMomSensor: api/components/sensors/umjsubtreeangmomsensor.md
#         - UMjSubtreeComSensor: api/components/sensors/umjsubtreecomsensor.md
#         - UMjSubtreeLinVelSensor: api/components/sensors/umjsubtreelinvelsensor.md
#         - UMjTactileSensor: api/components/sensors/umjtactilesensor.md
#         - UMjTendonActFrcSensor: api/components/sensors/umjtendonactfrcsensor.md
#         - UMjTendonLimitFrcSensor: api/components/sensors/umjtendonlimitfrcsensor.md
#         - UMjTendonLimitPosSensor: api/components/sensors/umjtendonlimitpossensor.md
#         - UMjTendonLimitVelSensor: api/components/sensors/umjtendonlimitvelsensor.md
#         - UMjTendonPosSensor: api/components/sensors/umjtendonpossensor.md
#         - UMjTendonVelSensor: api/components/sensors/umjtendonvelsensor.md
#         - UMjTorqueSensor: api/components/sensors/umjtorquesensor.md
#         - UMjTouchSensor: api/components/sensors/umjtouchsensor.md
#         - UMjVelocimeter: api/components/sensors/umjvelocimeter.md
#       - Geometry:
#         - EMjGeomType: api/components/geometry/emjgeomtype.md
#         - EMjSiteType: api/components/geometry/emjsitetype.md
#         - UMjGeom: api/components/geometry/umjgeom.md
#         - UMjSite: api/components/geometry/umjsite.md
#         - Primitives:
#           - UMjBox: api/components/geometry/primitives/umjbox.md
#           - UMjCylinder: api/components/geometry/primitives/umjcylinder.md
#           - UMjSphere: api/components/geometry/primitives/umjsphere.md
#       - Physics:
#         - UMjInertial: api/components/physics/umjinertial.md
#       - Quick Convert:
#         - AMjHeightfieldActor: api/components/quickconvert/amjheightfieldactor.md
#         - UMjQuickConvertComponent: api/components/quickconvert/umjquickconvertcomponent.md
#       - Constraints:
#         - EMjEqualityType: api/components/constraints/emjequalitytype.md
#         - UMjEquality: api/components/constraints/umjequality.md
#       - Defaults:
#         - UMjDefault: api/components/defaults/umjdefault.md
#       - Keyframes:
#         - UMjKeyframe: api/components/keyframes/umjkeyframe.md
#       - Tendons:
#         - EMjTendonWrapType: api/components/tendons/emjtendonwraptype.md
#         - FMjTendonWrap: api/components/tendons/fmjtendonwrap.md
#         - UMjTendon: api/components/tendons/umjtendon.md
#     - Factories:
#       - FMuJoCoMaterialData: api/factories/fmujocomaterialdata.md
#       - UMjArticulationFactory: api/factories/umjarticulationfactory.md
#       - UMujocoGenerationAction: api/factories/umujocogenerationaction.md
#       - UMujocoImportFactory: api/factories/umujocoimportfactory.md
#     - Networking:
#       - FMjInputBinding: api/net/fmjinputbinding.md
#       - UMjInputMapping: api/net/umjinputmapping.md
#       - UMujocoZmqComponent: api/net/umujocozmqcomponent.md
#       - UZmqControlSubscriber: api/net/uzmqcontrolsubscriber.md
#       - UZmqSensorBroadcaster: api/net/uzmqsensorbroadcaster.md
#     - Replay:
#       - FMjBodyKinematics: api/replay/fmjbodykinematics.md
#       - FMjReplayFrame: api/replay/fmjreplayframe.md
#       - AMjReplayManager: api/replay/amjreplaymanager.md
#     - UI:
#       - EMjPropertyType: api/ui/emjpropertytype.md
#       - UActuatorCallbackProxy: api/ui/uactuatorcallbackproxy.md
#       - UMjCameraFeedEntry: api/ui/umjcamerafeedentry.md
#       - UMjPropertyRow: api/ui/umjpropertyrow.md
#       - UMjSimulateWidget: api/ui/umjsimulatewidget.md
#     - Utilities:
#       - ActuatorView: api/utils/actuatorview.md
#       - BodyView: api/utils/bodyview.md
#       - FMjCompilerSettings: api/utils/fmjcompilersettings.md
#       - GeomView: api/utils/geomview.md
#       - JointView: api/utils/jointview.md
#       - MjOrientationUtils: api/utils/mjorientationutils.md
#       - MujocoUtils: api/utils/mujocoutils.md
#       - MujocoXmlUtils: api/utils/mujocoxmlutils.md
#       - SensorView: api/utils/sensorview.md
#       - TendonView: api/utils/tendonview.md
#     - Other:
#       - AURLabGameMode: api/other/aurlabgamemode.md