Improve warning messages for never_run sphinx and doxygen

Signed-off-by: R. Kent James <[email protected]>
ros-infrastructure · Nov 21, 2024 · 9ee86a5 · 9ee86a5
1 parent f20dbe2
commit 9ee86a5
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/rosdoc2/verbs/build/builders/doxygen_builder.py b/rosdoc2/verbs/build/builders/doxygen_builder.py
@@ -182,7 +182,7 @@ def build(self, *, doc_build_folder, output_staging_directory):
             return None  # Explicitly generated no documentation.
 
         if self.build_context.never_run_doxygen:
-            logger.debug('The package has never_run_doxygen set, so skipping doxygen.')
+            logger.info('The package has never_run_doxygen set, so skipping doxygen.')
             return None
 
         # If both doxyfile and doxyfile_content are None, that means there is

diff --git a/rosdoc2/verbs/build/builders/sphinx_builder.py b/rosdoc2/verbs/build/builders/sphinx_builder.py
@@ -542,6 +542,9 @@ def build(self, *, doc_build_folder, output_staging_directory):
         ]
 
         build_context = self.build_context
+        if build_context.never_run_sphinx_apidoc:
+            logger.info(
+                'The package has never_run_sphinx_apidoc set, so sphinx apidoc will not be run.')
         has_python = (
             build_context.build_type == 'ament_python'
             or build_context.always_run_sphinx_apidoc