forked from isaac-sim/IsaacLab
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Restructures documentation and fixes class types (isaac-sim#98)
# Description This change restructures documentation to add a new Overview section that combines previous pages around learning workflows, environment design, and developer guides. New pages are added for RL library comparison and training performance benchmarking. ## Type of change <!-- As you go through the list, delete the ones that are not applicable. --> - Bug fix (non-breaking change which fixes an issue) - New feature (non-breaking change which adds functionality) - This change requires a documentation update ## Checklist - [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./isaaclab.sh --format` - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have updated the changelog and the corresponding version in the extension's `config/extension.toml` file - [x] I have added my name to the `CONTRIBUTORS.md` or my name already exists there <!-- As you go through the checklist above, you can mark something as done by putting an x character in it For example, - [x] I have done this task - [ ] I have not done this task -->
- Loading branch information
1 parent
4a3e4d7
commit 4e76296
Showing
23 changed files
with
713 additions
and
421 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
109 changes: 0 additions & 109 deletions
109
docs/source/setup/developer.rst → ...e/overview/developer-guide/extensions.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| Developer's Guide | ||
| ================= | ||
|
|
||
| For development, we suggest using `Microsoft Visual Studio Code | ||
| (VSCode) <https://code.visualstudio.com/>`__. This is also suggested by | ||
| NVIDIA Omniverse and there exists tutorials on how to `debug Omniverse | ||
| extensions <https://www.youtube.com/watch?v=Vr1bLtF1f4U&ab_channel=NVIDIAOmniverse>`__ | ||
| using VSCode. | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
|
|
||
| vs_code | ||
| repo_structure | ||
| extensions | ||
| template |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| Repository organization | ||
| ----------------------- | ||
|
|
||
| The ``Isaac Lab`` repository is structured as follows: | ||
|
|
||
| .. code-block:: bash | ||
| IsaacLab | ||
| ├── .vscode | ||
| ├── .flake8 | ||
| ├── LICENSE | ||
| ├── isaaclab.sh | ||
| ├── pyproject.toml | ||
| ├── README.md | ||
| ├── docs | ||
| ├── source | ||
| │ ├── extensions | ||
| │ │ ├── omni.isaac.lab | ||
| │ │ ├── omni.isaac.lab_assets | ||
| │ │ └── omni.isaac.lab_tasks | ||
| │ ├── standalone | ||
| │ │ ├── demos | ||
| │ │ ├── environments | ||
| │ │ ├── tools | ||
| │ │ ├── tutorials | ||
| │ │ └── workflows | ||
| └── VERSION | ||
| The ``source`` directory contains the source code for all ``Isaac Lab`` *extensions* | ||
| and *standalone applications*. The two are the different development workflows | ||
| supported in `Isaac Sim <https://docs.omniverse.nvidia.com/isaacsim/latest/introductory_tutorials/tutorial_intro_workflows.html>`__. | ||
| These are described in the following sections. |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| Setting up Visual Studio Code | ||
| ----------------------------- | ||
|
|
||
| The following is only applicable for Isaac Sim installed via the Omniverse Launcher. | ||
| The ``Isaac Lab`` repository includes the VSCode settings to easily allow setting | ||
| up your development environment. These are included in the ``.vscode`` directory | ||
| and include the following files: | ||
|
|
||
| .. code-block:: bash | ||
| .vscode | ||
| ├── tools | ||
| │ ├── launch.template.json | ||
| │ ├── settings.template.json | ||
| │ └── setup_vscode.py | ||
| ├── extensions.json | ||
| ├── launch.json # <- this is generated by setup_vscode.py | ||
| ├── settings.json # <- this is generated by setup_vscode.py | ||
| └── tasks.json | ||
| To setup the IDE, please follow these instructions: | ||
|
|
||
| 1. Open the ``Isaac Lab`` directory on Visual Studio Code IDE | ||
| 2. Run VSCode `Tasks <https://code.visualstudio.com/docs/editor/tasks>`__, by | ||
| pressing ``Ctrl+Shift+P``, selecting ``Tasks: Run Task`` and running the | ||
| ``setup_python_env`` in the drop down menu. | ||
|
|
||
| .. image:: ../../_static/vscode_tasks.png | ||
| :width: 600px | ||
| :align: center | ||
| :alt: VSCode Tasks | ||
|
|
||
| If everything executes correctly, it should create the following files: | ||
|
|
||
| * ``.vscode/launch.json``: Contains the launch configurations for debugging python code. | ||
| * ``.vscode/settings.json``: Contains the settings for the python interpreter and the python environment. | ||
|
|
||
| For more information on VSCode support for Omniverse, please refer to the | ||
| following links: | ||
|
|
||
| * `Isaac Sim VSCode support <https://docs.omniverse.nvidia.com/app_isaacsim/app_isaacsim/manual_standalone_python.html#isaac-sim-python-vscode>`__ | ||
| * `Debugging with VSCode <https://docs.omniverse.nvidia.com/isaacsim/latest/advanced_tutorials/tutorial_advanced_python_debugging.html>`__ | ||
|
|
||
|
|
||
| Configuring the python interpreter | ||
| ---------------------------------- | ||
|
|
||
| In the provided configuration, we set the default python interpreter to use the | ||
| python executable provided by Omniverse. This is specified in the | ||
| ``.vscode/settings.json`` file: | ||
|
|
||
| .. code-block:: json | ||
| { | ||
| "python.defaultInterpreterPath": "${workspaceFolder}/_isaac_sim/python.sh", | ||
| } | ||
| If you want to use a different python interpreter (for instance, from your conda environment), | ||
| you need to change the python interpreter used by selecting and activating the python interpreter | ||
| of your choice in the bottom left corner of VSCode, or opening the command palette (``Ctrl+Shift+P``) | ||
| and selecting ``Python: Select Interpreter``. | ||
|
|
||
| For more information on how to set python interpreter for VSCode, please | ||
| refer to the `VSCode documentation <https://code.visualstudio.com/docs/python/environments#_working-with-python-interpreters>`_. |
Oops, something went wrong.