Skip to content

Commit d086133

Browse files
leander-dsouzaleander-dsouza
committed
Ensure unix-style formatting without Windows carriage returns.
Signed-off-by: Leander Stephen D'Souza <leanderdsouza1234@gmail.com>
1 parent eee6efd commit d086133

2 files changed

Lines changed: 77 additions & 77 deletions

File tree

‎.pre-commit-config.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ repos:
3333
rev: v2.0.0
3434
hooks:
3535
- id: doc8
36-
args: ['--ignore=D001,D004']
36+
args: ['--ignore=D001'] # ignore line length rule

‎setup_guides/index.rst‎

Lines changed: 76 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,76 @@
1-
.. _setup_guides:
2-
3-
First-Time Robot Setup Guide
4-
############################
5-
6-
This section is a collection of guides that aims to provide readers a good resource for setting up Nav2. The objectives for this section are as follows:
7-
8-
- Help new users with setting up Navigation2 with a new robot
9-
- Help people with custom built robots to properly set up their robots to be used in ROS/Navigation2
10-
- Act as a checklist, template or boilerplate reference for more experienced readers
11-
- Provide examples which can be run on simulators/tools like Gazebo or RViz to guide readers on the Nav2 setup process even without a physical robot.
12-
- Broad strokes, tips, and tricks for configuring certain packages and integrating different components of the robot platform (sensors, odometry, etc.)
13-
14-
To guide you through the first-time setup of your robot, we will be tackling the following topics:
15-
16-
- Introduce TF2 and setup your robot URDF & SDF
17-
18-
- Setup sensor sources for robot odometry
19-
- Setup sensor sources for perception
20-
- Configure round or arbitrary shaped footprints for your robot
21-
- Select and set up planner and controller navigation plugins for your robot's navigation tasks
22-
- Lifecycle node management for easy bringup of other related sensors or nodes
23-
24-
There are tutorials below for the Gazebo Classic simulator and the Gazebo simulator. Gazebo Classic is used with ROS 2 Humble and previous ROS distributions, while Gazebo (Gazebo Harmonic or newer) is used with ROS 2 Jazzy or newer.
25-
26-
27-
Table of Contents
28-
=================
29-
30-
.. raw:: html
31-
32-
<div style="display: flex; gap: 20px;">
33-
34-
<div style="flex: 1; padding: 10px; border-right: 1px solid #ccc;">
35-
36-
<h3 style="text-align: center;">Gazebo</h3>
37-
38-
.. toctree::
39-
:maxdepth: 1
40-
41-
transformation/setup_transforms.rst
42-
urdf/setup_urdf.rst
43-
sdf/setup_sdf.rst
44-
odom/setup_odom_gz.rst
45-
odom/setup_robot_localization.rst
46-
sensors/setup_sensors_gz.rst
47-
sensors/mapping_localization.rst
48-
footprint/setup_footprint.rst
49-
algorithm/select_algorithm.rst
50-
51-
.. raw:: html
52-
53-
</div>
54-
55-
<div style="flex: 1; padding: 10px;">
56-
57-
<h3 style="text-align: center;">Gazebo Classic</h3>
58-
59-
.. toctree::
60-
:maxdepth: 1
61-
62-
transformation/setup_transforms.rst
63-
urdf/setup_urdf.rst
64-
odom/setup_odom_gz_classic.rst
65-
odom/setup_robot_localization.rst
66-
sensors/setup_sensors_gz_classic.rst
67-
sensors/mapping_localization.rst
68-
footprint/setup_footprint.rst
69-
algorithm/select_algorithm.rst
70-
71-
.. raw:: html
72-
73-
</div>
74-
</div>
75-
76-
.. note:: These tutorials are not meant to be full tuning and configuration guides since they only aim to help you get your robot up and running with a basic configuration. For more detailed discussions and guides on how to customize and tune Nav2 for your robot, head on to the :ref:`configuration` section.
1+
.. _setup_guides:
2+
3+
First-Time Robot Setup Guide
4+
############################
5+
6+
This section is a collection of guides that aims to provide readers a good resource for setting up Nav2. The objectives for this section are as follows:
7+
8+
- Help new users with setting up Navigation2 with a new robot
9+
- Help people with custom built robots to properly set up their robots to be used in ROS/Navigation2
10+
- Act as a checklist, template or boilerplate reference for more experienced readers
11+
- Provide examples which can be run on simulators/tools like Gazebo or RViz to guide readers on the Nav2 setup process even without a physical robot.
12+
- Broad strokes, tips, and tricks for configuring certain packages and integrating different components of the robot platform (sensors, odometry, etc.)
13+
14+
To guide you through the first-time setup of your robot, we will be tackling the following topics:
15+
16+
- Introduce TF2 and setup your robot URDF & SDF
17+
18+
- Setup sensor sources for robot odometry
19+
- Setup sensor sources for perception
20+
- Configure round or arbitrary shaped footprints for your robot
21+
- Select and set up planner and controller navigation plugins for your robot's navigation tasks
22+
- Lifecycle node management for easy bringup of other related sensors or nodes
23+
24+
There are tutorials below for the Gazebo Classic simulator and the Gazebo simulator. Gazebo Classic is used with ROS 2 Humble and previous ROS distributions, while Gazebo (Gazebo Harmonic or newer) is used with ROS 2 Jazzy or newer.
25+
26+
27+
Table of Contents
28+
=================
29+
30+
.. raw:: html
31+
32+
<div style="display: flex; gap: 20px;">
33+
34+
<div style="flex: 1; padding: 10px; border-right: 1px solid #ccc;">
35+
36+
<h3 style="text-align: center;">Gazebo</h3>
37+
38+
.. toctree::
39+
:maxdepth: 1
40+
41+
transformation/setup_transforms.rst
42+
urdf/setup_urdf.rst
43+
sdf/setup_sdf.rst
44+
odom/setup_odom_gz.rst
45+
odom/setup_robot_localization.rst
46+
sensors/setup_sensors_gz.rst
47+
sensors/mapping_localization.rst
48+
footprint/setup_footprint.rst
49+
algorithm/select_algorithm.rst
50+
51+
.. raw:: html
52+
53+
</div>
54+
55+
<div style="flex: 1; padding: 10px;">
56+
57+
<h3 style="text-align: center;">Gazebo Classic</h3>
58+
59+
.. toctree::
60+
:maxdepth: 1
61+
62+
transformation/setup_transforms.rst
63+
urdf/setup_urdf.rst
64+
odom/setup_odom_gz_classic.rst
65+
odom/setup_robot_localization.rst
66+
sensors/setup_sensors_gz_classic.rst
67+
sensors/mapping_localization.rst
68+
footprint/setup_footprint.rst
69+
algorithm/select_algorithm.rst
70+
71+
.. raw:: html
72+
73+
</div>
74+
</div>
75+
76+
.. note:: These tutorials are not meant to be full tuning and configuration guides since they only aim to help you get your robot up and running with a basic configuration. For more detailed discussions and guides on how to customize and tune Nav2 for your robot, head on to the :ref:`configuration` section.

0 commit comments

Comments
 (0)