Skip to content

Commit

Permalink
shit shit shit shit shit shit shit shit
Browse files Browse the repository at this point in the history
  • Loading branch information
fan-ziqi committed Oct 15, 2024
1 parent b0d4984 commit 1f30a06
Show file tree
Hide file tree
Showing 539 changed files with 284,590 additions and 9 deletions.
39 changes: 39 additions & 0 deletions .github/workflows/gh-pages-zhcn.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: gh-pages-zhcn

on:
push:
branches:
- main
workflow_dispatch:

jobs:
gh-pages-zhcn:
runs-on: ubuntu-latest

steps:
- name: Checkout user's repo (main branch)
uses: actions/checkout@v2
with:
repository: fan-ziqi/IsaacLab
ref: main

- name: Configure git user
run: |
git config --global user.name 'fan-ziqi'
git config --global user.email '[email protected]'
- name: Copy generated HTML files to temporary Path
run: |
mkdir -p temp_html
cp -r docs/_build/html/* temp_html/
- name: Commit and push changes to gh-pages-zhcn branch
run: |
git checkout --orphan gh-pages-zhcn
git rm -rf .
rm -rf docs source
cp -r temp_html/* .
rm -rf temp_html
git add .
git commit -m "Update translated documentation"
git push origin gh-pages-zhcn --force
10 changes: 5 additions & 5 deletions .github/workflows/sync-and-translate.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name: Sync and Translate Documentation

on:
push:
branches:
- main
# push:
# branches:
# - main
# schedule:
# - cron: '0 0 * * *'
workflow_dispatch:
Expand Down Expand Up @@ -46,7 +46,7 @@ jobs:
- name: Generate gettext
run: |
pushd docs
make -i gettext
make gettext
popd
- name: Update translations
Expand All @@ -64,7 +64,7 @@ jobs:
- name: Build HTML with translations
run: |
pushd docs
make -i SPHINXOPTS="-D language='zh_CN'" html
make -e SPHINXOPTS="-D language='zh_CN'" html
popd
- name: Copy generated HTML files to temporary Path
Expand Down
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ docker/artifacts/
# Isaac-Sim packman
_isaac_sim*
_repo
_build
# _build
.lastformat

# RL-Games
Expand All @@ -59,3 +59,4 @@ _build
**/recordings/*

*.mo
!**/docs/_build/html
4 changes: 4 additions & 0 deletions docs/_build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 783bde5f52a1e1af6abf2202b4068195
tags: 645f666f9bcd5a90fca523b33c5a78b7
Empty file added docs/_build/html/.nojekyll
Empty file.
Binary file added docs/_build/html/_images/a1_flat.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_build/html/_images/a1_rough.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
364 changes: 364 additions & 0 deletions docs/_build/html/_images/a3c-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
385 changes: 385 additions & 0 deletions docs/_build/html/_images/a3c-light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
522 changes: 522 additions & 0 deletions docs/_build/html/_images/actuator-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10,214 changes: 10,214 additions & 0 deletions docs/_build/html/_images/actuator-light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_build/html/_images/allegro_cube.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_build/html/_images/ant.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_build/html/_images/anymal_b_flat.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_build/html/_images/anymal_b_rough.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_build/html/_images/anymal_c_flat.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_build/html/_images/anymal_c_nav.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_build/html/_images/anymal_c_rough.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_build/html/_images/anymal_d_flat.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_build/html/_images/anymal_d_rough.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_build/html/_images/arms.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_build/html/_images/box_terrain.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_build/html/_images/cartpole.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_build/html/_images/cartpole1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_build/html/_images/cartpole_camera.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_build/html/_images/deformables.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_build/html/_images/flat_terrain.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_build/html/_images/franka_lift.jpg
Binary file added docs/_build/html/_images/franka_open_drawer.jpg
Binary file added docs/_build/html/_images/franka_reach.jpg
Binary file added docs/_build/html/_images/g1_flat.jpg
Binary file added docs/_build/html/_images/g1_rough.jpg
Binary file added docs/_build/html/_images/g1_rough1.jpg
Binary file added docs/_build/html/_images/gap_terrain.jpg
Binary file added docs/_build/html/_images/go1_flat.jpg
Binary file added docs/_build/html/_images/go1_rough.jpg
Binary file added docs/_build/html/_images/go2_flat.jpg
Binary file added docs/_build/html/_images/go2_rough.jpg
Binary file added docs/_build/html/_images/h1_flat.jpg
Binary file added docs/_build/html/_images/h1_rough.jpg
Binary file added docs/_build/html/_images/hands.jpg
Binary file added docs/_build/html/_images/humanoid.jpg
Binary file added docs/_build/html/_images/isaaclab.jpg
Binary file added docs/_build/html/_images/markers.jpg
Binary file added docs/_build/html/_images/multi_asset.jpg
Binary file added docs/_build/html/_images/pit_terrain.jpg
Binary file added docs/_build/html/_images/procedural_terrain.jpg
Binary file added docs/_build/html/_images/quadcopter.jpg
Binary file added docs/_build/html/_images/quadrupeds.jpg
Binary file added docs/_build/html/_images/rails_terrain.jpg
Binary file added docs/_build/html/_images/random_grid_terrain.jpg
Binary file added docs/_build/html/_images/shadow.jpg
Binary file added docs/_build/html/_images/shadow_cube.jpg
Binary file added docs/_build/html/_images/shadow_hand_over.jpg
Binary file added docs/_build/html/_images/spot_flat.jpg
Binary file added docs/_build/html/_images/star_terrain.jpg
Binary file added docs/_build/html/_images/tasks.jpg
Binary file added docs/_build/html/_images/thanks.png
Binary file added docs/_build/html/_images/tutorial_launch_app.jpg
Binary file added docs/_build/html/_images/ur10_reach.jpg
Binary file added docs/_build/html/_images/vscode_tasks.png
Binary file added docs/_build/html/_images/wave_terrain.jpg
Binary file added docs/_build/html/_images/wechat-group1-1015.jpg
715 changes: 715 additions & 0 deletions docs/_build/html/_modules/index.html

Large diffs are not rendered by default.

822 changes: 822 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/actuators/actuator_base.html

Large diffs are not rendered by default.

763 changes: 763 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/actuators/actuator_cfg.html

Large diffs are not rendered by default.

763 changes: 763 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/actuators/actuator_net.html

Large diffs are not rendered by default.

923 changes: 923 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/actuators/actuator_pd.html

Large diffs are not rendered by default.

1,272 changes: 1,272 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/app/app_launcher.html

Large diffs are not rendered by default.

1,949 changes: 1,949 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/assets/articulation/articulation.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

843 changes: 843 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/assets/asset_base.html

Large diffs are not rendered by default.

650 changes: 650 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/assets/asset_base_cfg.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

625 changes: 625 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/devices/device_base.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

709 changes: 709 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/envs/common.html

Large diffs are not rendered by default.

1,276 changes: 1,276 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/envs/direct_marl_env.html

Large diffs are not rendered by default.

714 changes: 714 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/envs/direct_marl_env_cfg.html

Large diffs are not rendered by default.

1,212 changes: 1,212 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/envs/direct_rl_env.html

Large diffs are not rendered by default.

715 changes: 715 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/envs/direct_rl_env_cfg.html

Large diffs are not rendered by default.

949 changes: 949 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/envs/manager_based_env.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

610 changes: 610 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/envs/mdp/curriculums.html

Large diffs are not rendered by default.

1,574 changes: 1,574 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/envs/mdp/events.html

Large diffs are not rendered by default.

832 changes: 832 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/envs/mdp/observations.html

Large diffs are not rendered by default.

872 changes: 872 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/envs/mdp/rewards.html

Large diffs are not rendered by default.

732 changes: 732 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/envs/mdp/terminations.html

Large diffs are not rendered by default.

977 changes: 977 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/envs/ui/base_env_window.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

938 changes: 938 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/managers/action_manager.html

Large diffs are not rendered by default.

971 changes: 971 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/managers/command_manager.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

953 changes: 953 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/managers/event_manager.html

Large diffs are not rendered by default.

861 changes: 861 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/managers/manager_base.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

797 changes: 797 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/managers/reward_manager.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

1,074 changes: 1,074 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/scene/interactive_scene.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

1,257 changes: 1,257 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/sensors/camera/camera.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

865 changes: 865 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/sensors/sensor_base.html

Large diffs are not rendered by default.

616 changes: 616 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/sensors/sensor_base_cfg.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

1,392 changes: 1,392 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/sim/schemas/schemas.html

Large diffs are not rendered by default.

941 changes: 941 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/sim/schemas/schemas_cfg.html

Large diffs are not rendered by default.

810 changes: 810 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/sim/simulation_cfg.html

Large diffs are not rendered by default.

1,347 changes: 1,347 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/sim/simulation_context.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

692 changes: 692 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/sim/spawners/spawner_cfg.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

1,438 changes: 1,438 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/sim/utils.html

Large diffs are not rendered by default.

1,010 changes: 1,010 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/terrains/height_field/hf_terrains.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

1,426 changes: 1,426 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/terrains/trimesh/mesh_terrains.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

849 changes: 849 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/terrains/utils.html

Large diffs are not rendered by default.

669 changes: 669 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/utils/array.html

Large diffs are not rendered by default.

702 changes: 702 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/utils/assets.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

1,010 changes: 1,010 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/utils/configclass.html

Large diffs are not rendered by default.

871 changes: 871 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/utils/dict.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

624 changes: 624 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/utils/io/pkl.html

Large diffs are not rendered by default.

629 changes: 629 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/utils/io/yaml.html

Large diffs are not rendered by default.

1,994 changes: 1,994 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/utils/math.html

Large diffs are not rendered by default.

833 changes: 833 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/utils/modifiers/modifier.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

666 changes: 666 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/utils/noise/noise_cfg.html

Large diffs are not rendered by default.

756 changes: 756 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/utils/noise/noise_model.html

Large diffs are not rendered by default.

942 changes: 942 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/utils/string.html

Large diffs are not rendered by default.

745 changes: 745 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/utils/timer.html

Large diffs are not rendered by default.

719 changes: 719 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab/utils/warp/ops.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

661 changes: 661 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab_tasks/utils/importer.html

Large diffs are not rendered by default.

772 changes: 772 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab_tasks/utils/parse_cfg.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

922 changes: 922 additions & 0 deletions docs/_build/html/_modules/omni/isaac/lab_tasks/utils/wrappers/sb3.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

159 changes: 159 additions & 0 deletions docs/_build/html/_sources/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
Overview
========

.. figure:: source/_static/isaaclab.jpg
:width: 100%
:alt: H1 Humanoid example using Isaac Lab


.. attention:: 本翻译项目不属于 NVIDIA 或 IsaacLab 官方文档,由 `范子琦 <https://github.com/fan-ziqi>`__ 提供中文翻译,仅供学习交流使用,禁止转载或用于商业用途。详情请查看 `关于翻译 <source/setup/translation.html>`_ 章节。

**Isaac Lab** is a unified and modular framework for robot learning that aims to simplify common workflows
in robotics research (such as reinforcement learning, learning from demonstrations, and motion planning). It is built upon
`NVIDIA Isaac Sim`_ to leverage the latest simulation capabilities for photo-realistic scenes, and fast
and efficient simulation.

The core objectives of the framework are:

- **Modularity**: Easily customize and add new environments, robots, and sensors.
- **Agility**: Adapt to the changing needs of the community.
- **Openness**: Remain open-sourced to allow the community to contribute and extend the framework.
- **Battery-included**: Include a number of environments, sensors, and tasks that are ready to use.

Key features available in Isaac Lab include fast and accurate physics simulation provided by PhysX,
tiled rendering APIs for vectorized rendering, domain randomization for improving robustness and adaptability,
and support for running in the cloud.

Additionally, Isaac Lab provides over 26 environments, and we are actively working on adding more environments
to the list. These include classic control tasks, fixed-arm and dexterous manipulation tasks, legged locomotion tasks,
and navigation tasks. A complete list is available in the `environments <source/overview/environments>`_ section.

The framework also includes over 16 robots. If you are looking to add a new robot, please refer to the
:ref:`how-to` section. The current list of robots includes:

- **Classic** Cartpole, Humanoid, Ant
- **Fixed-Arm and Hands**: UR10, Franka, Allegro, Shadow Hand
- **Quadrupeds**: Anybotics Anymal-B, Anymal-C, Anymal-D, Unitree A1, Unitree Go1, Unitree Go2, Boston Dynamics Spot
- **Humanoids**: Unitree H1, Unitree G1
- **Quadcopter**: Crazyflie

For more information about the framework, please refer to the `paper <https://arxiv.org/abs/2301.04195>`_
:cite:`mittal2023orbit`. For clarifications on NVIDIA Isaac ecosystem, please check out the
:doc:`/source/setup/faq` section.

.. figure:: source/_static/tasks.jpg
:width: 100%
:alt: Example tasks created using Isaac Lab


License
=======

The Isaac Lab framework is open-sourced under the BSD-3-Clause license.
Please refer to :ref:`license` for more details.

Acknowledgement
===============
Isaac Lab development initiated from the `Orbit <https://isaac-orbit.github.io/>`_ framework. We would appreciate if you would cite it in academic publications as well:

.. code:: bibtex
@article{mittal2023orbit,
author={Mittal, Mayank and Yu, Calvin and Yu, Qinxi and Liu, Jingzhou and Rudin, Nikita and Hoeller, David and Yuan, Jia Lin and Singh, Ritvik and Guo, Yunrong and Mazhar, Hammad and Mandlekar, Ajay and Babich, Buck and State, Gavriel and Hutter, Marco and Garg, Animesh},
journal={IEEE Robotics and Automation Letters},
title={Orbit: A Unified Simulation Framework for Interactive Robot Learning Environments},
year={2023},
volume={8},
number={6},
pages={3740-3747},
doi={10.1109/LRA.2023.3270034}
}
Table of Contents
=================

.. toctree::
:maxdepth: 2
:caption: Getting Started

source/setup/wechat
source/setup/translation
source/setup/installation/index
source/setup/faq

.. toctree::
:maxdepth: 3
:caption: Overview
:titlesonly:

source/overview/developer-guide/index
source/overview/core-concepts/index
source/overview/environments
source/overview/reinforcement-learning/index
source/overview/teleop_imitation
source/overview/showroom
source/overview/simple_agents

.. toctree::
:maxdepth: 2
:caption: Features

source/features/hydra
source/features/multi_gpu
source/features/tiled_rendering
source/features/reproducibility
.. source/features/motion_generators

.. toctree::
:maxdepth: 1
:caption: Resources
:titlesonly:

source/tutorials/index
source/how-to/index
source/deployment/index

.. toctree::
:maxdepth: 1
:caption: Migration Guides
:titlesonly:

source/migration/migrating_from_isaacgymenvs
source/migration/migrating_from_omniisaacgymenvs
source/migration/migrating_from_orbit

.. toctree::
:maxdepth: 1
:caption: Source API

source/api/index

.. toctree::
:maxdepth: 1
:caption: References

source/refs/additional_resources
source/refs/contributing
source/refs/troubleshooting
source/refs/issues
source/refs/changelog
source/refs/license
source/refs/bibliography

.. toctree::
:hidden:
:caption: Project Links

GitHub <https://github.com/isaac-sim/IsaacLab>
NVIDIA Isaac Sim <https://docs.omniverse.nvidia.com/isaacsim/latest/index.html>
NVIDIA PhysX <https://nvidia-omniverse.github.io/PhysX/physx/5.4.1/index.html>

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. _NVIDIA Isaac Sim: https://docs.omniverse.nvidia.com/isaacsim/latest/index.html
57 changes: 57 additions & 0 deletions docs/_build/html/_sources/source/api/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
API Reference
=============

This page gives an overview of all the modules and classes in the Isaac Lab extensions.

omni.isaac.lab extension
------------------------

The following modules are available in the ``omni.isaac.lab`` extension:

.. currentmodule:: omni.isaac.lab

.. autosummary::
:toctree: lab

app
actuators
assets
controllers
devices
envs
managers
markers
scene
sensors
sim
terrains
utils

.. toctree::
:hidden:

lab/omni.isaac.lab.envs.mdp
lab/omni.isaac.lab.envs.ui
lab/omni.isaac.lab.sensors.patterns
lab/omni.isaac.lab.sim.converters
lab/omni.isaac.lab.sim.schemas
lab/omni.isaac.lab.sim.spawners

omni.isaac.lab_tasks extension
--------------------------------

The following modules are available in the ``omni.isaac.lab_tasks`` extension:

.. currentmodule:: omni.isaac.lab_tasks

.. autosummary::
:toctree: lab_tasks

utils


.. toctree::
:hidden:

lab_tasks/omni.isaac.lab_tasks.utils.wrappers
lab_tasks/omni.isaac.lab_tasks.utils.data_collector
Loading

0 comments on commit 1f30a06

Please sign in to comment.