From 643400174763da17e0f226d3615b33d594ddb27b Mon Sep 17 00:00:00 2001 From: Yuval Tassa Date: Sun, 11 Jun 2023 19:59:27 -0700 Subject: [PATCH] Remove "Main struct types" subsection from APItypes.rst, for quicker access (fewer clicks) to main struct reference. PiperOrigin-RevId: 539525003 Change-Id: I01a3b7e4b054c3acda0a0070c227d50d7f43ea72 --- doc/APIreference/APItypes.rst | 22 ++++++++++------------ doc/overview.rst | 14 ++++++++------ 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/doc/APIreference/APItypes.rst b/doc/APIreference/APItypes.rst index b0329c49..d3e78000 100644 --- a/doc/APIreference/APItypes.rst +++ b/doc/APIreference/APItypes.rst @@ -20,7 +20,12 @@ MuJoCo defines a large number of types: - :ref:`C struct types`. These can be classified as: - - :ref:`Main struct types`. These are :ref:`mjModel`, :ref:`mjOption` and :ref:`mjData`. + - Main structs: + + - :ref:`mjModel`. + - :ref:`mjOption` (embedded in :ref:`mjModel`). + - :ref:`mjData`. + - :ref:`Auxillary struct types`, also used by the engine. - Structs for collecting :ref:`simulation statistics`. - Structs for :ref:`abstract visualization`. @@ -581,21 +586,14 @@ Capabilities declared by an engine plugin. Struct types ------------ - -.. _tyMainStructure: - -Main -^^^^ - The three central struct types for physics simulation are :ref:`mjModel`, :ref:`mjOption` (embedded in :ref:`mjModel`) -and :ref:`mjData`. An introductory discussion of these strucures can be found in the Overview under :ref:`Separation of -model and data`. +and :ref:`mjData`. An introductory discussion of these strucures can be found in the :ref:`Overview`. .. _mjModel: mjModel -~~~~~~~ +^^^^^^^ This is the main data structure holding the MuJoCo model. It is treated as constant by the simulator. Some specific details regarding datastructures in :ref:`mjModel` can be found below in :ref:`tyNotes`. @@ -607,7 +605,7 @@ details regarding datastructures in :ref:`mjModel` can be found below in :ref:`t .. _mjOption: mjOption -~~~~~~~~ +^^^^^^^^ This is the data structure with simulation options. It corresponds to the MJCF element :ref:`option