diff --git a/changelog.md b/changelog.md index 524ac0e..87c479b 100644 --- a/changelog.md +++ b/changelog.md @@ -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 diff --git a/doc/source/_static/switcher.json b/doc/source/_static/switcher.json new file mode 100644 index 0000000..2afa07d --- /dev/null +++ b/doc/source/_static/switcher.json @@ -0,0 +1,7 @@ +[ + { + "name": "2.2.6 (latest)", + "version": "2.2.6", + "url": "https://ir-sim.readthedocs.io/en/latest/" + } +] \ No newline at end of file diff --git a/doc/source/conf.py b/doc/source/conf.py index 8b6f1c7..68a6a4f 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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): diff --git a/doc/source/usage/configure_dynamic_random_env.md b/doc/source/usage/configure_dynamic_random_env.md index 927deca..6eb3b91 100644 --- a/doc/source/usage/configure_dynamic_random_env.md +++ b/doc/source/usage/configure_dynamic_random_env.md @@ -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/)