diff --git a/doc/APIreference/APIfunctions.rst b/doc/APIreference/APIfunctions.rst index 05ff7804..d22cb717 100644 --- a/doc/APIreference/APIfunctions.rst +++ b/doc/APIreference/APIfunctions.rst @@ -4,11 +4,37 @@ Functions ========= -The main header `mujoco.h `_ exposes a very large -number of functions. However the functions that most users are likely to need are a small fraction. For example, -:ref:`simulate.cc ` which is as elaborate as a MuJoCo application is likely to get, calls around 40 of these -functions, while ``basic.cc`` calls around 20. The rest are explosed just in case someone has a use for them. This -includes us as users of MuJoCo -- we do our own work with the public library instead of relying on internal builds. +The main header `mujoco.h `_ exposes a large +number of functions. However the functions that most users are likely to need are a small fraction. + +API function can be classified as: + +- :ref:`Virtual file system`, used to load assets from memory. +- :ref:`Parse and compile` an :ref:`mjModel` from XML files and assets. +- :ref:`Main simulation` entry points, including :ref:`mj_step`. +- :ref:`Initialization` of data structures. +- :ref:`Printing` of various quantities. +- :ref:`Components` of the simulation pipeline, called from :ref:`mj_step`, :ref:`mj_forward` and :ref:`mj_inverse`. +- :ref:`Sub components` of the simulation pipeline. +- :ref:`Support` functions requiring :ref:`mjModel` and :ref:`mjData`. +- :ref:`Ray casting`. +- :ref:`Abstract interaction`: mouse control of cameras and perturbations. +- :ref:`Abstract Visualization`. +- :ref:`OpenGL rendering`. +- :ref:`UI framework`. +- :ref:`Error and memory`. +- Deprecated :ref:`activation` mechanism. +- :ref:`Aliases for C standard math` functions. +- :ref:`Vector math`. +- :ref:`Quaternions`. +- :ref:`Poses transformations`. +- :ref:`Matrix decompositions and solvers`. +- :ref:`Miscellaneous` functions. +- :ref:`Dynamics derivatives`. +- :ref:`Plugin` related functions. +- :ref:`Macros`. + +.. TODO(b/273075045): Better category-label namespacing. .. include:: functions.rst diff --git a/doc/APIreference/index.rst b/doc/APIreference/index.rst index fb592c2c..3d1f0980 100644 --- a/doc/APIreference/index.rst +++ b/doc/APIreference/index.rst @@ -4,11 +4,11 @@ API Reference ============= -This chapter is the reference manual for MuJoCo. It is generated from the header files included with MuJoCo, but also -contains additional text not available in the headers. +This chapter is the reference manual for the MuJoCo API. It is automatically kept in sync with MuJoCo's header files, +but also contains additional information not available in the headers. The API is composed of 3 categories: .. toctree:: - :maxdepth: 2 + :maxdepth: 1 APItypes APIglobals