Skip to content

Commit

Permalink
Update Doc version
Browse files Browse the repository at this point in the history
  • Loading branch information
hanruihua committed Dec 22, 2024
1 parent 6b27a38 commit 8f18b31
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 2 deletions.
4 changes: 3 additions & 1 deletion changelog.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
## ir-sim 2.3.0

**Major Version Update:**

- Reorganize the lidar2d step function to make it faster.
- Reformulate the kinematics handler and geometry handler to configure the robot and obstacles.
- Update the comments for the functions.
- Add the coverage test for the project.
- Complete the documentation for the project.
- Fix some bugs of default parameters.
- Fix some bugs in the project.
- Add 3d plot environment.

## ir-sim 2.2.6
Expand Down
7 changes: 7 additions & 0 deletions doc/source/_static/switcher.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[
{
"name": "2.2.6 (latest)",
"version": "2.2.6",
"url": "https://ir-sim.readthedocs.io/en/latest/"
}
]
7 changes: 7 additions & 0 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,13 @@ def __getattr__(cls, name):
# "tasklist",
# ]

json_url = "https://ir-sim.readthedocs.io/en/dev/_static/switcher.json"

html_theme_options = {
"switcher": {
"json_url": json_url,
},
}


def setup(app):
Expand Down
2 changes: 1 addition & 1 deletion doc/source/usage/configure_dynamic_random_env.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ The parameters to generate random obstacles with various shapes are the settings

- The `shape` parameter is used to set the random shape of the obstacles by setting the `random_shape` to `True`.
- For circular obstacles, the `radius` will be randomly generated within `radius_range`.
- For polygon obstacles, `avg_radius_range`, `irregularity_range`, `num_vertices_range`, and `spikeyness_range` defines which type of polygon will be generated. See [random_generate_polygon](#irsim.lib.algorithm.generation.random_generate_polygon) for details.
- For polygon obstacles, `avg_radius_range`, `irregularity_range`, `num_vertices_range`, and `spikeyness_range` define which type of polygon will be generated. See [random_generate_polygon](#irsim.lib.algorithm.generation.random_generate_polygon) for details.

The details of the parameters are listed in the [YAML Configuration](../yaml_config/configuration/)

Expand Down

0 comments on commit 8f18b31

Please sign in to comment.