Merge pull request #62 from MOLAorg/docs-fixes

Docs fixes
MOLAorg · Aug 8, 2024 · 5385a41 · 5385a41
2 parents 4df67dc + 7d6cfa8
commit 5385a41
Show file tree

Hide file tree

Showing 24 changed files with 87 additions and 49 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -67,6 +67,55 @@ Get started:
 
 |
 
+.. humble badges ------
+
+.. |badgeHdev| image:: https://build.ros2.org/job/Hdev__mola__ubuntu_jammy_amd64/badge/icon
+ :scale: 100%
+ :align: middle
+ :target: https://build.ros2.org/job/Hdev__mola__ubuntu_jammy_amd64/
+
+.. |badgeHrel| image:: https://img.shields.io/ros/v/humble/mola
+ :scale: 100%
+ :align: middle
+ :target: https://index.ros.org/search/?term=mola
+
+.. iron badges ------
+
+.. |badgeIdev| image:: https://build.ros2.org/job/Idev__mola__ubuntu_jammy_amd64/badge/icon
+ :scale: 100%
+ :align: middle
+ :target: https://build.ros2.org/job/Idev__mola__ubuntu_jammy_amd64/
+
+.. |badgeIrel| image:: https://img.shields.io/ros/v/iron/mola
+ :scale: 100%
+ :align: middle
+ :target: https://index.ros.org/search/?term=mola
+
+.. jazzy badges ------
+
+.. |badgeJdev| image:: https://build.ros2.org/job/Jdev__mola__ubuntu_noble_amd64/badge/icon
+ :scale: 100%
+ :align: middle
+ :target: https://build.ros2.org/job/Jdev__mola__ubuntu_noble_amd64/
+
+.. |badgeJrel| image:: https://img.shields.io/ros/v/jazzy/mola
+ :scale: 100%
+ :align: middle
+ :target: https://index.ros.org/search/?term=mola
+
+.. rolling badges ------
+
+.. |badgeRdev| image:: https://build.ros2.org/job/Rdev__mola__ubuntu_noble_amd64/badge/icon
+ :scale: 100%
+ :align: middle
+ :target: https://build.ros2.org/job/Rdev__mola__ubuntu_noble_amd64/
+
+.. |badgeRrel| image:: https://img.shields.io/ros/v/rolling/mola
+ :scale: 100%
+ :align: middle
+ :target: https://index.ros.org/search/?term=mola
+
+
 .. _installing:
 
 Installing
@@ -104,8 +153,19 @@ How to install all MOLA modules:
  # If a GUI app is opened, it means installation was successful.
  mm-viewer
 
- Check the `build status table <https://github.com/MOLAorg/mola>`_ to find out
- what MOLA version is available for your ROS distribution.
+ These are the versions available from ROS build farms:
+
+ +-------------------------+-----------------------------+------------------------------------+
+ | ROS distribution | Development build status | Last release (available via apt) |
+ +=========================+=============================+====================================+
+ | ROS 2 Humble (u22.04) | |badgeHdev| | |badgeHrel| |
+ +-------------------------+-----------------------------+------------------------------------+
+ | ROS 2 Iron (u22.04) | |badgeIdev| | |badgeIrel| |
+ +-------------------------+-----------------------------+------------------------------------+
+ | ROS 2 Jazzy (u24.04) | |badgeJdev| | |badgeJrel| |
+ +-------------------------+-----------------------------+------------------------------------+
+ | ROS 2 Rolling (u24.04) | |badgeRdev| | |badgeRrel| |
+ +-------------------------+-----------------------------+------------------------------------+
 
 
 .. dropdown:: Build from sources

diff --git a/kitti_metrics_eval/package.xml b/kitti_metrics_eval/package.xml
@@ -8,12 +8,11 @@
  <version>1.0.8</version>
  <description>CLI tool to evaluate the KITTI odometry bechmark metrics to trajectory files</description>
 
- <author email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</author>
  <maintainer email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</maintainer>
+ <license file="LICENSE">BSD</license>
 
  <url type="website">https://github.com/MOLAorg/mola/tree/develop/kitti_metrics_eval</url>
 
- <license file="LICENSE">BSD</license>
 
  <depend>mola_common</depend>
  <depend>mrpt2</depend>

diff --git a/mola/package.xml b/mola/package.xml
@@ -4,8 +4,8 @@
  <name>mola</name>
  <version>1.0.8</version>
  <description>Metapackage with all core open-sourced MOLA packages.</description>
+
  <maintainer email="jlblanco@ual.es">Jose-Luis Blanco-Claraco</maintainer>
- <author>Jose-Luis Blanco-Claraco</author>
  <license file="LICENSE">BSD</license>
 
  <buildtool_depend>ament_cmake</buildtool_depend>

diff --git a/mola_bridge_ros2/package.xml b/mola_bridge_ros2/package.xml
@@ -8,13 +8,11 @@
  <version>1.0.8</version>
  <description>Bidirectional bridge ROS2-MOLA</description>
 
- <author email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</author>
  <maintainer email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</maintainer>
+ <license file="LICENSE">BSD</license>
 
  <url type="website">https://github.com/MOLAorg/mola/tree/develop/mola_bridge_ros2</url>
 
- <license file="LICENSE">BSD</license>
-
  <doc_depend>doxygen</doc_depend>
 
  <!-- COMMON DEPS -->

diff --git a/mola_demos/package.xml b/mola_demos/package.xml
@@ -8,14 +8,13 @@
  <version>1.0.8</version>
  <description>Demo and example launch files for MOLA</description>
 
- <author email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</author>
  <maintainer email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</maintainer>
+ <license file="LICENSE">BSD</license>
 
  <url type="website">https://github.com/MOLAorg/</url>
 
- <license file="LICENSE">BSD</license>
 
-<!-- <depend>mola_common</depend> -->
+ <!-- <depend>mola_common</depend> -->
 
  <doc_depend>doxygen</doc_depend>
 

diff --git a/mola_imu_preintegration/package.xml b/mola_imu_preintegration/package.xml
@@ -8,12 +8,11 @@
  <version>1.0.8</version>
  <description>Integrator of IMU angular velocity readings</description>
 
- <author email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</author>
  <maintainer email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</maintainer>
+ <license file="LICENSE">GPLv3</license>
 
  <url type="website">https://github.com/MOLAorg/mola/tree/develop/mola_imu_preintegration</url>
 
- <license file="LICENSE">GPLv3</license>
 
  <depend>mola_common</depend>
  <depend>mrpt2</depend>

diff --git a/mola_input_euroc_dataset/package.xml b/mola_input_euroc_dataset/package.xml
@@ -8,12 +8,11 @@
  <version>1.0.8</version>
  <description>Offline RawDataSource from EUROC SLAM datasets</description>
 
- <author email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</author>
  <maintainer email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</maintainer>
+ <license file="LICENSE">BSD</license>
 
  <url type="website">https://github.com/MOLAorg/mola/tree/develop/mola_input_euroc_dataset</url>
 
- <license file="LICENSE">BSD</license>
 
  <depend>mola_common</depend>
  <depend>mola_kernel</depend>

diff --git a/mola_input_kitti360_dataset/package.xml b/mola_input_kitti360_dataset/package.xml
@@ -8,12 +8,11 @@
  <version>1.0.8</version>
  <description>Offline RawDataSource from Kitti-360 datasets</description>
 
- <author email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</author>
  <maintainer email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</maintainer>
+ <license file="LICENSE">GPLv3</license>
 
  <url type="website">https://github.com/MOLAorg/mola/tree/develop/mola_input_kitti360_dataset</url>
 
- <license file="LICENSE">GPLv3</license>
 
  <depend>mola_common</depend>
  <depend>mola_kernel</depend>

diff --git a/mola_input_kitti_dataset/package.xml b/mola_input_kitti_dataset/package.xml
@@ -8,12 +8,11 @@
  <version>1.0.8</version>
  <description>Offline RawDataSource from Kitti odometry/SLAM datasets</description>
 
- <author email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</author>
  <maintainer email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</maintainer>
+ <license file="LICENSE">GPLv3</license>
 
  <url type="website">https://github.com/MOLAorg/mola/tree/develop/mola_input_kitti_dataset</url>
 
- <license file="LICENSE">GPLv3</license>
 
  <depend>mola_common</depend>
  <depend>mola_kernel</depend>

diff --git a/mola_input_mulran_dataset/package.xml b/mola_input_mulran_dataset/package.xml
@@ -8,12 +8,11 @@
  <version>1.0.8</version>
  <description>Offline RawDataSource from MulRan datasets</description>
 
- <author email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</author>
  <maintainer email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</maintainer>
+ <license file="LICENSE">GPLv3</license>
 
  <url type="website">https://github.com/MOLAorg/mola/tree/develop/mola_input_mulran_dataset</url>
 
- <license file="LICENSE">GPLv3</license>
 
  <depend>mola_common</depend>
  <depend>mola_kernel</depend>

diff --git a/mola_input_paris_luco_dataset/package.xml b/mola_input_paris_luco_dataset/package.xml
@@ -8,12 +8,11 @@
  <version>1.0.8</version>
  <description>Offline RawDataSource from Paris LUCO (CT-ICP) odometry/SLAM datasets</description>
 
- <author email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</author>
  <maintainer email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</maintainer>
+ <license file="LICENSE">GPLv3</license>
 
  <url type="website">https://github.com/MOLAorg/mola/tree/develop/mola_input_paris_luco_dataset</url>
 
- <license file="LICENSE">GPLv3</license>
 
  <depend>mola_common</depend>
  <depend>mola_kernel</depend>

diff --git a/mola_input_rawlog/package.xml b/mola_input_rawlog/package.xml
@@ -8,12 +8,11 @@
  <version>1.0.8</version>
  <description>Offline RawDataSource from MRPT rawlog datasets</description>
 
- <author email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</author>
  <maintainer email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</maintainer>
+ <license file="LICENSE">GPLv3</license>
 
  <url type="website">https://github.com/MOLAorg/mola/tree/develop/mola_input_rawlog</url>
 
- <license file="LICENSE">GPLv3</license>
 
  <depend>mola_kernel</depend>
  <depend>mrpt2</depend>

diff --git a/mola_input_rosbag2/package.xml b/mola_input_rosbag2/package.xml
@@ -8,12 +8,11 @@
  <version>1.0.8</version>
  <description>Offline RawDataSource from rosbag2 datasets</description>
 
- <author email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</author>
  <maintainer email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</maintainer>
+ <license file="LICENSE">GPLv3</license>
 
  <url type="website">https://github.com/MOLAorg/mola/tree/develop/mola_input_rosbag2</url>
 
- <license file="LICENSE">GPLv3</license>
 
  <depend>mola_kernel</depend>
  <depend>mrpt2</depend>

diff --git a/mola_kernel/package.xml b/mola_kernel/package.xml
@@ -8,12 +8,11 @@
  <version>1.0.8</version>
  <description>Fundamental C++ virtual interfaces and data types for the rest of MOLA modules</description>
 
- <author email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</author>
  <maintainer email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</maintainer>
+ <license file="LICENSE">GPLv3</license>
 
  <url type="website">https://github.com/MOLAorg/mola/tree/develop/mola_kernel</url>
 
- <license file="LICENSE">GPLv3</license>
 
  <depend>mola_common</depend>
  <depend>mola_yaml</depend>

diff --git a/mola_launcher/package.xml b/mola_launcher/package.xml
@@ -8,12 +8,11 @@
  <version>1.0.8</version>
  <description>Launcher app for MOLA systems</description>
 
- <author email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</author>
  <maintainer email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</maintainer>
+ <license file="LICENSE">GPLv3</license>
 
  <url type="website">https://github.com/MOLAorg/mola/tree/develop/mola_launcher</url>
 
- <license file="LICENSE">GPLv3</license>
 
  <depend>mola_kernel</depend>
  <depend>mrpt2</depend>

diff --git a/mola_metric_maps/package.xml b/mola_metric_maps/package.xml
@@ -8,12 +8,11 @@
  <version>1.0.8</version>
  <description>Advanced metric map classes, using the generic `mrpt::maps::CMetricMap` interface, for use in other MOLA odometry and SLAM modules.</description>
 
- <author email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</author>
  <maintainer email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</maintainer>
+ <license file="LICENSE">GPLv3</license>
 
  <url type="website">https://github.com/MOLAorg/mola/tree/develop/mola_metric_maps</url>
 
- <license file="LICENSE">GPLv3</license>
 
  <depend>mola_common</depend>
  <depend>mrpt2</depend>

diff --git a/mola_msgs/package.xml b/mola_msgs/package.xml
@@ -6,10 +6,10 @@
  <description>ROS message, services, and actions used in other MOLA packages.</description>
 
  <maintainer email="joseluisblancoc@gmail.com">Jose Luis Blanco-Claraco</maintainer>
+ <license file="LICENSE">GPLv3</license>
 
  <url type="website">https://github.com/MOLAorg/mola/tree/develop/mola_msgs</url>
 
- <license file="LICENSE">GPLv3</license>
 
  <buildtool_depend>ament_cmake</buildtool_depend>
 

diff --git a/mola_navstate_fg/package.xml b/mola_navstate_fg/package.xml
@@ -8,18 +8,17 @@
  <version>1.0.8</version>
  <description>SE(3) pose and twist path data fusion estimator</description>
 
- <author email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</author>
  <maintainer email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</maintainer>
+ <license file="LICENSE">GPLv3</license>
 
  <url type="website">https://github.com/MOLAorg/mola/tree/develop/mola_navstate_fuse</url>
 
- <license file="LICENSE">GPLv3</license>
 
  <depend>mola_common</depend>
  <depend>mola_kernel</depend>
  <depend>mola_imu_preintegration</depend>
  <depend>mrpt2</depend>
- 
+
  <!-- GTSAM and its Boost deps -->
  <build_depend>gtsam</build_depend>
  <build_depend>libboost-serialization-dev</build_depend>

diff --git a/mola_navstate_fuse/package.xml b/mola_navstate_fuse/package.xml
@@ -8,12 +8,11 @@
  <version>1.0.8</version>
  <description>SE(3) pose and twist path data fusion estimator</description>
 
- <author email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</author>
  <maintainer email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</maintainer>
+ <license file="LICENSE">GPLv3</license>
 
  <url type="website">https://github.com/MOLAorg/mola/tree/develop/mola_navstate_fuse</url>
 
- <license file="LICENSE">GPLv3</license>
 
  <depend>mola_common</depend>
  <depend>mola_kernel</depend>

diff --git a/mola_pose_list/package.xml b/mola_pose_list/package.xml
@@ -8,12 +8,11 @@
  <version>1.0.8</version>
  <description>C++ library for searchable pose lists</description>
 
- <author email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</author>
  <maintainer email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</maintainer>
+ <license file="LICENSE">GPLv3</license>
 
  <url type="website">https://github.com/MOLAorg/mola/tree/develop/mola_pose_list</url>
 
- <license file="LICENSE">GPLv3</license>
 
  <depend>mola_common</depend>
  <depend>mrpt2</depend>

diff --git a/mola_relocalization/package.xml b/mola_relocalization/package.xml
@@ -8,12 +8,11 @@
  <version>1.0.8</version>
  <description>C++ library with algorithms for relocalization, global localization, or pose estimation given a large initial uncertainty</description>
 
- <author email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</author>
  <maintainer email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</maintainer>
+ <license file="LICENSE">GPLv3</license>
 
  <url type="website">https://github.com/MOLAorg/mola/tree/develop/mola_relocalization</url>
 
- <license file="LICENSE">GPLv3</license>
 
  <depend>mola_common</depend>
  <depend>mrpt2</depend>

diff --git a/mola_traj_tools/package.xml b/mola_traj_tools/package.xml
@@ -8,12 +8,11 @@
  <version>1.0.8</version>
  <description>CLI tools to manipulate trajectory files as a complement to the evo package</description>
 
- <author email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</author>
  <maintainer email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</maintainer>
+ <license file="LICENSE">BSD</license>
 
  <url type="website">https://github.com/MOLAorg/mola/tree/develop/mola_traj_tools</url>
 
- <license file="LICENSE">BSD</license>
 
  <depend>mola_common</depend>
  <depend>mrpt2</depend>

diff --git a/mola_viz/package.xml b/mola_viz/package.xml
@@ -8,12 +8,11 @@
  <version>1.0.8</version>
  <description>GUI for MOLA</description>
 
- <author email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</author>
  <maintainer email="joseluisblancoc@gmail.com">Jose-Luis Blanco-Claraco</maintainer>
+ <license file="LICENSE">GPLv3</license>
 
  <url type="website">https://github.com/MOLAorg/mola/tree/develop/mola_viz</url>
 
- <license file="LICENSE">GPLv3</license>
 
  <depend>mola_kernel</depend>
  <depend>mrpt2</depend>