chore(docs): fix documentation pre-commit errors

tier4 · mojomex · Jun 26, 2024 · Jun 6, 2024 · Jun 6, 2024 · Jun 6, 2024
commit c442c8c70cc329d785bcfc1db08be68d7271bd4b
diff --git a/README.md b/README.md
@@ -1,13 +1,16 @@
 # Nebula
 
 ## Welcome to Nebula, the universal sensor driver
+
 Nebula is a sensor driver platform that is designed to provide a unified framework for as wide a variety of devices as possible.
-While it primarily targets Ethernet-based LiDAR sensors, it aims to be easily extendable to support new sensors and interfaces. 
+While it primarily targets Ethernet-based LiDAR sensors, it aims to be easily extendable to support new sensors and interfaces.
 Nebula works with ROS 2 and is the recommended sensor driver for the [Autoware](https://autoware.org/) project.
 
 ## Documentation
+
 We recommend you get started with the [Nebula Documention](https://tier4.github.io/nebula/).
 Here you will find information about the background of the project, how to install and use with ROS 2, and also how to add new sensors to the Nebula driver.
+
 - [About Nebula](https://tier4.github.io/nebula/about)
 - [Design](https://tier4.github.io/nebula/design)
 - [Supported Sensors](https://tier4.github.io/nebula/supported_sensors)
@@ -19,6 +22,7 @@ Here you will find information about the background of the project, how to insta
 - [Tutorials](https://tier4.github.io/nebula/tutorials)
 
 ## Quick start
+
 Nebula builds with ROS 2 Galactic and Humble.
 
 > **Note**
@@ -39,13 +43,15 @@ rosdep install --from-paths src --ignore-src -y -r
 # Build Nebula
 colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release
 ```
+
 To launch Nebula as a ROS 2 node with default parameters for your sensor model:
 
 ```bash
 ros2 launch nebula_ros *sensor_vendor_name*_launch_all_hw.xml sensor_model:=*sensor_model_name*
 ```
 
 For example, for a Hesai Pandar40P sensor:
+
 ```bash
 ros2 launch nebula_ros hesai_launch_all_hw.xml sensor_model:=Pandar40P
 ```
diff --git a/docs/about.md b/docs/about.md
@@ -1,7 +1,3 @@
 # About Nebula
 
 WIP, please check back soon!
-
-
-
-
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -1,3 +1,3 @@
 # Contributing to Nebula
 
-WIP - please check back soon!
+WIP - please check back soon!
diff --git a/docs/index.md b/docs/index.md
@@ -1,9 +1,11 @@
 # Welcome to the Nebula documentation
+
 Welcome to the Nebula documentation. Here you will find information about the background of the project, how to install and use with ROS 2, and also how to add new sensors to the Nebula driver.
 
-# About Nebula
+## About Nebula
+
 Nebula is a sensor driver platform that is designed to provide a unified framework for as wide a variety of devices as possible.
-While it primarily targets Ethernet-based LiDAR sensors, it aims to be easily extendable to support new sensors and interfaces. 
+While it primarily targets Ethernet-based LiDAR sensors, it aims to be easily extendable to support new sensors and interfaces.
 Nebula works with ROS 2 and is the recommended sensor driver for the [Autoware](https://autoware.org/) project. The project aims to provide:
 
 - A universal sensor driver
@@ -15,18 +17,22 @@ Nebula works with ROS 2 and is the recommended sensor driver for the [Autoware](
 
 For more information, please refer to [About Nebula](about.md).
 
-# Getting started
+## Getting started
+
 - [Installation](installation.md)
 - [Launching with ROS 2](usage.md)
 
-# Nebula architecture
+## Nebula architecture
+
 - [Design](design.md)
 - [Parameters](parameters.md)
 - [Point cloud types](point_types.md)
 
-# Supported sensors
+## Supported sensors
+
 - [Supported sensors](supported_sensors.md)
 
-# Development
+## Development
+
 - [Tutorials](tutorials.md)
-- [Contributing](contributing.md)
+- [Contributing](contributing.md)
diff --git a/docs/installation.md b/docs/installation.md
@@ -1,11 +1,12 @@
 # Installing Nebula
 
 ## Requirements
+
 Nebula requires ROS 2 (Galactic or Humble) to build the ROS 2 wrapper.
 Please see the [ROS 2 documentation](https://docs.ros.org/en/humble/index.html) for how to install.
 
-
 ## Getting the source and building
+
 > **Note**
 >
 > A [TCP enabled version of ROS' Transport Driver](https://github.com/mojomex/transport_drivers/tree/mutable-buffer-in-udp-callback) is required to use Nebula.
@@ -28,6 +29,7 @@ colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release
 ## Testing your build
 
 To run Nebula unit tests:
+
 ```bash
 colcon test --event-handlers console_cohesion+ --packages-above nebula_common
 ```
@@ -36,4 +38,4 @@ Show results:
 
 ```bash
 colcon test-result --all
-```
+```
diff --git a/docs/parameters.md b/docs/parameters.md
@@ -118,4 +118,4 @@ Parameters shared by all supported models:
 | min_range        | double | 0.3      | meters, >= 0.3   | Minimum point range published |
 | max_range        | double | 300.0    | meters, <= 300.0 | Maximum point range published |
 | cloud_min_angle  | uint16 | 0        | degrees [0, 360] | FoV start angle               |
-| cloud_max_angle  | uint16 | 359      | degrees [0, 360] | FoV end angle                 |
+| cloud_max_angle  | uint16 | 359      | degrees [0, 360] | FoV end angle                 |
diff --git a/docs/point_types.md b/docs/point_types.md
@@ -53,4 +53,4 @@ These definitions can be found in the `nebula_common/include/point_types.hpp`.
 | `return type` | `uint8` |           | Contains the lase return type according to the sensor configuration.       |
 | `azimuth`     | `float` | `degrees` | Contains the azimuth of the current point.                                 |
 | `distance`    | `float` | `m`       | Contains the distance from the sensor origin to this echo on the XY plane. |
-| `timestamp`   | `float` | `ns`      | Contains the relative time to the triggered scan time.                   
+| `timestamp`   | `float` | `ns`      | Contains the relative time to the triggered scan time.                     |
diff --git a/docs/supported_sensors.md b/docs/supported_sensors.md
@@ -1,45 +1,44 @@
 # Supported sensors
 
-Nebula currently supports the following sensor models, where  `sensor_model` is the ROS parameter to be used at launch:
+Nebula currently supports the following sensor models, where `sensor_model` is the ROS parameter to be used at launch:
 
 ## Hesai LiDARs
 
-| Model         | `sensor_model` | Configuration file | Test status          |
-| ------------- | -------------- | ------------------ | -------------------- |
-| Pandar64      | Pandar64       | Pandar64.yaml      | ✅                   |
-| Pandar 40P    | Pandar40P      | Pandar40P.yaml     | ✅                   |
-| Pandar XT32   | PandarXT32     | PandarXT32.yaml    | ✅                   |
-| Pandar XT32M  | PandarXT32M    | PandarXT32M.yaml   | ⚠️                    |
-| Pandar QT64   | PandarQT64     | PandarQT64.yaml    | ✅                   |
-| Pandar QT128  | PandarQT128    | PandarQT128.yaml   | ⚠️                    |
-| Pandar AT128  | PandarAT128    | PandarAT128.yaml   | ✅\*                 |
-| Pandar 128E4X | Pandar128E4X   | Pandar128E4X.yaml  | ⚠️                    |
+| Model         | `sensor_model` | Configuration file | Test status |
+| ------------- | -------------- | ------------------ | ----------- |
+| Pandar64      | Pandar64       | Pandar64.yaml      | ✅          |
+| Pandar 40P    | Pandar40P      | Pandar40P.yaml     | ✅          |
+| Pandar XT32   | PandarXT32     | PandarXT32.yaml    | ✅          |
+| Pandar XT32M  | PandarXT32M    | PandarXT32M.yaml   | ⚠️          |
+| Pandar QT64   | PandarQT64     | PandarQT64.yaml    | ✅          |
+| Pandar QT128  | PandarQT128    | PandarQT128.yaml   | ⚠️          |
+| Pandar AT128  | PandarAT128    | PandarAT128.yaml   | ✅\*        |
+| Pandar 128E4X | Pandar128E4X   | Pandar128E4X.yaml  | ⚠️          |
 
 ## Velodyne LiDARs
 
-| Model         | `sensor_model` | Configuration file | Test status          |
-| ------------- | -------------- | ------------------ | -------------------- |
-| VLP-16        | VLP16          | VLP16.yaml         | ⚠️                    |
-| VLP-16-HiRes  | VLP16          |                    | ❌                   |
-| VLP-32        | VLP32          | VLP32.yaml         | ⚠️                    |
-| VLS-128       | VLS128         | VLS128.yaml        | ⚠️                    |
+| Model        | `sensor_model` | Configuration file | Test status |
+| ------------ | -------------- | ------------------ | ----------- |
+| VLP-16       | VLP16          | VLP16.yaml         | ⚠️          |
+| VLP-16-HiRes | VLP16          |                    | ❌          |
+| VLP-32       | VLP32          | VLP32.yaml         | ⚠️          |
+| VLS-128      | VLS128         | VLS128.yaml        | ⚠️          |
 
 ## Robosense LiDARs
 
-| Model         | `sensor_model` | Configuration file | Test status          |
-| ------------- | -------------- | ------------------ | -------------------- |
-| Bpearl        | Bpearl         | Bpearl.yaml        | ⚠️                    |
-| Helios        | Helios         | Helios.yaml        | ⚠️                    |
+| Model  | `sensor_model` | Configuration file | Test status |
+| ------ | -------------- | ------------------ | ----------- |
+| Bpearl | Bpearl         | Bpearl.yaml        | ⚠️          |
+| Helios | Helios         | Helios.yaml        | ⚠️          |
 
 ## Continental radars
 
-| Model         | `sensor_model` | Configuration file | Test status          |
-| ------------- | -------------- | ------------------ | -------------------- |
-| ARS548        | ARS548         | ARS548.yaml        | ⚠️                    |
+| Model  | `sensor_model` | Configuration file | Test status |
+| ------ | -------------- | ------------------ | ----------- |
+| ARS548 | ARS548         | ARS548.yaml        | ⚠️          |
 
-
-Test status:\
-✅: complete\
-⚠️: some functionality yet to be tested\
-❌: untested\
-\*: AT128 needs software version 3.50.8 or newer for the `scan_angle` setting to work correctly.
+Test status:  
+✅: complete  
+⚠️: some functionality yet to be tested  
+❌: untested  
+\*: AT128 needs software version 3.50.8 or newer for the `scan_angle` setting to work correctly.
diff --git a/docs/tutorials.md b/docs/tutorials.md
@@ -1,4 +1,4 @@
 # Nebula tutorials
 
 WIP - we are currently working on making tutorials for Nebula development, so please check back soon!
-In the meantime, check out the [tutorial branch](https://github.com/mojomex/nebula/tree/single-node-refactor-tutorial).
+In the meantime, check out the [tutorial branch](https://github.com/mojomex/nebula/tree/single-node-refactor-tutorial).
diff --git a/docs/usage.md b/docs/usage.md
@@ -1,16 +1,19 @@
 # Running Nebula
 
 ## Launch with default parameters
+
 To launch Nebula as a ROS 2 node with default parameters for your sensor model:
 
 ```bash
 ros2 launch nebula_ros *sensor_vendor_name*_launch_all_hw.xml sensor_model:=*sensor_model_name*
 ```
 
 For example, for a Hesai Pandar40P sensor:
+
 ```bash
 ros2 launch nebula_ros hesai_launch_all_hw.xml sensor_model:=Pandar40P
 ```
 
 ## Sensor configuration
-WIP
+
+WIP
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -55,49 +55,49 @@ plugins:
       projects:
         nebula_common:
           src-dirs: nebula_common/include
-          full-doc: True
+          full-doc: true
           doxy-cfg:
             FILE_PATTERNS: "*.hpp *.h"
-            RECURSIVE: True
-            EXTRACT_ALL: True
-            INLINE_SOURCES: True
-            ENABLE_PREPROCESSING: True
-            MACRO_EXPANSION: True
+            RECURSIVE: true
+            EXTRACT_ALL: true
+            INLINE_SOURCES: true
+            ENABLE_PREPROCESSING: true
+            MACRO_EXPANSION: true
         nebula_decoders:
           src-dirs: nebula_decoders/include
-          full-doc: True
+          full-doc: true
           doxy-cfg:
             FILE_PATTERNS: "*.hpp *.h"
-            RECURSIVE: True
-            EXTRACT_ALL: True
-            INLINE_SOURCES: True
-            ENABLE_PREPROCESSING: True
-            MACRO_EXPANSION: True
+            RECURSIVE: true
+            EXTRACT_ALL: true
+            INLINE_SOURCES: true
+            ENABLE_PREPROCESSING: true
+            MACRO_EXPANSION: true
         nebula_hw_interfaces:
           src-dirs: nebula_hw_interfaces/include
-          full-doc: True
+          full-doc: true
           doxy-cfg:
             FILE_PATTERNS: "*.hpp *.h"
-            RECURSIVE: True
-            EXTRACT_ALL: True
-            INLINE_SOURCES: True
-            ENABLE_PREPROCESSING: True
-            MACRO_EXPANSION: True
+            RECURSIVE: true
+            EXTRACT_ALL: true
+            INLINE_SOURCES: true
+            ENABLE_PREPROCESSING: true
+            MACRO_EXPANSION: true
         nebula_ros:
           src-dirs: nebula_ros/include
-          full-doc: True
+          full-doc: true
           doxy-cfg:
             FILE_PATTERNS: "*.hpp *.h"
-            RECURSIVE: True
-            EXTRACT_ALL: True
-            INLINE_SOURCES: True
-            ENABLE_PREPROCESSING: True
-            MACRO_EXPANSION: True
+            RECURSIVE: true
+            EXTRACT_ALL: true
+            INLINE_SOURCES: true
+            ENABLE_PREPROCESSING: true
+            MACRO_EXPANSION: true
 
       save-api: .mkdoxy
-      full-doc: True
-      debug: False
-      ignore-errors: False
+      full-doc: true
+      debug: false
+      ignore-errors: false
 
   - search:
       lang: en