Add package description to home page (#112)

ros-infrastructure · Apr 18, 2024 · bd2b7d7 · bd2b7d7
1 parent 6ffc9c4
commit bd2b7d7
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/rosdoc2/verbs/build/builders/index.rst.jinja b/rosdoc2/verbs/build/builders/index.rst.jinja
@@ -3,6 +3,8 @@
 Welcome to the documentation for {{ package.name }}
 ================================={% for _ in package.name %}={% endfor %}
 
+{{ package.description }}
+
 .. toctree::
    :maxdepth: 2
 

diff --git a/test/test_builder.py b/test/test_builder.py
@@ -214,6 +214,7 @@ def test_full_package(session_dir):
         'action definitions',
         'instructions',  # has documentation
         'changelog',
+        'full ros2 test package',  # the package description
     ]
     file_includes = [
         'generated/index.html'