Ask Your Question

Revision history [back]

click to hide/show revision 1
initial version

rosdoc_lite and raw messages in generated documentaion

According to

https://github.com/ros-infrastructure/rosdoc_lite/issues/29

in the comments field

"Good point. I've put support for raw messages back in. This should fix up all the documentation the next time all the doc jobs run."

I have now tested the latest rosdoc_lite (latest Ubuntu packages) for private documentation and this does not work for me. And I cannot find any flag to rosdoc_lite to enable this. So how should I start rosdoc_lite to get the raw messages included in the generated documentation?

This all worked in rosdoc.

rosdoc_lite and raw messages in generated documentaion

According to

https://github.com/ros-infrastructure/rosdoc_lite/issues/29

in the comments field

"Good point. I've put support for raw messages back in. This should fix up all the documentation the next time all the doc jobs run."

I have now tested the latest rosdoc_lite (latest Ubuntu packages) for private documentation and this does not work for me. And I cannot find any flag to rosdoc_lite to enable this. So how should I start rosdoc_lite to get the raw messages included in the generated documentation?

This all worked in rosdoc.

Adding more information_

Running by using target:

add_custom_target (lrs_msgs_doc 
  rosdoc_lite -o ${CATKIN_DEVEL_PREFIX}/doc/lrs_msgs ${CATKIN_DEVEL_PREFIX}/../src/lrs_msgs
)

The when running get the folloing output:

tompe@tpdell:~/lrs_ws$ catkin_make lrs_msgs_doc
Base path: /home/tompe/lrs_ws
Source space: /home/tompe/lrs_ws/src
Build space: /home/tompe/lrs_ws/build
Devel space: /home/tompe/lrs_ws/devel
Install space: /home/tompe/lrs_ws/install
####
#### Running command: "make cmake_check_build_system" in "/home/tompe/lrs_ws/build"
####
####
#### Running command: "make lrs_msgs_doc -j8 -l8" in "/home/tompe/lrs_ws/build"
####
Documenting a catkin package
Documenting lrs_msgs located here: /home/tompe/lrs_ws/src/lrs_msgs
{'doxygen': {'builder': 'doxygen', 'output_dir': '.'}}
{'builder': 'doxygen', 'output_dir': '.'}
Generated the following tagfile string 
doxygen-ating lrs_msgs [doxygen /tmp/tmpsZf1og]
warning: tag INCLUDE_PATH: include path `$INCLUDE_PATH' does not exist
warning: source $INCLUDE_PATH is not a readable file or directory... skipping.
[('VisFrustrum', '/home/tompe/lrs_ws/src/lrs_msgs/msg/VisFrustrum.msg'), ('GeoPoint', '/home/tompe/lrs_ws/src/lrs_msgs/msg/GeoPoint.msg'), ('Sticks', '/home/tompe/lrs_ws/src/lrs_msgs/msg/Sticks.msg'), ('MPParams', '/home/tompe/lrs_ws/src/lrs_msgs/msg/MPParams.msg'), ('PtuExtData', '/home/tompe/lrs_ws/src/lrs_msgs/msg/PtuExtData.msg'), ('TFPOPProblem', '/home/tompe/lrs_ws/src/lrs_msgs/msg/TFPOPProblem.msg'), ('PMAVInfo', '/home/tompe/lrs_ws/src/lrs_msgs/msg/PMAVInfo.msg'), ('LQQueueInfo', '/home/tompe/lrs_ws/src/lrs_msgs/msg/LQQueueInfo.msg'), ('TFPOPAnswer', '/home/tompe/lrs_ws/src/lrs_msgs/msg/TFPOPAnswer.msg'), ('PlatformParams', '/home/tompe/lrs_ws/src/lrs_msgs/msg/PlatformParams.msg'), ('SticksValue', '/home/tompe/lrs_ws/src/lrs_msgs/msg/SticksValue.msg'), ('QuadState', '/home/tompe/lrs_ws/src/lrs_msgs/msg/QuadState.msg'), ('LQClimbCommand', '/home/tompe/lrs_ws/src/lrs_msgs/msg/LQClimbCommand.msg'), ('ThreeDObject', '/home/tompe/lrs_ws/src/lrs_msgs/msg/ThreeDObject.msg'), ('TSTNodeStatus', '/home/tompe/lrs_ws/src/lrs_msgs/msg/TSTNodeStatus.msg'), ('LQStatus', '/home/tompe/lrs_ws/src/lrs_msgs/msg/LQStatus.msg'), ('MPRefinements', '/home/tompe/lrs_ws/src/lrs_msgs/msg/MPRefinements.msg'), ('LQPtuCommand', '/home/tompe/lrs_ws/src/lrs_msgs/msg/LQPtuCommand.msg'), ('TFPOPPlan', '/home/tompe/lrs_ws/src/lrs_msgs/msg/TFPOPPlan.msg'), ('LQQueueCommands', '/home/tompe/lrs_ws/src/lrs_msgs/msg/LQQueueCommands.msg'), ('LQFlyCommand', '/home/tompe/lrs_ws/src/lrs_msgs/msg/LQFlyCommand.msg'), ('TFPOPRequest', '/home/tompe/lrs_ws/src/lrs_msgs/msg/TFPOPRequest.msg'), ('TFPOPThread', '/home/tompe/lrs_ws/src/lrs_msgs/msg/TFPOPThread.msg'), ('TSTInfo', '/home/tompe/lrs_ws/src/lrs_msgs/msg/TSTInfo.msg'), ('OMPLInfo', '/home/tompe/lrs_ws/src/lrs_msgs/msg/OMPLInfo.msg'), ('RMAXStatus', '/home/tompe/lrs_ws/src/lrs_msgs/msg/RMAXStatus.msg'), ('Point', '/home/tompe/lrs_ws/src/lrs_msgs/msg/Point.msg'), ('ExtData', '/home/tompe/lrs_ws/src/lrs_msgs/msg/ExtData.msg'), ('VisDelete', '/home/tompe/lrs_ws/src/lrs_msgs/msg/VisDelete.msg'), ('MPRoadmap', '/home/tompe/lrs_ws/src/lrs_msgs/msg/MPRoadmap.msg'), ('HeliState', '/home/tompe/lrs_ws/src/lrs_msgs/msg/HeliState.msg'), ('TSTNodeInfo', '/home/tompe/lrs_ws/src/lrs_msgs/msg/TSTNodeInfo.msg'), ('BinaryData', '/home/tompe/lrs_ws/src/lrs_msgs/msg/BinaryData.msg'), ('DelInfo', '/home/tompe/lrs_ws/src/lrs_msgs/msg/DelInfo.msg'), ('TSTSymbolicMap', '/home/tompe/lrs_ws/src/lrs_msgs/msg/TSTSymbolicMap.msg'), ('TFPOPAction', '/home/tompe/lrs_ws/src/lrs_msgs/msg/TFPOPAction.msg'), ('RefData', '/home/tompe/lrs_ws/src/lrs_msgs/msg/RefData.msg'), ('VisTrackBallHome', '/home/tompe/lrs_ws/src/lrs_msgs/msg/VisTrackBallHome.msg'), ('MotionPlan', '/home/tompe/lrs_ws/src/lrs_msgs/msg/MotionPlan.msg'), ('LQYawCommand', '/home/tompe/lrs_ws/src/lrs_msgs/msg/LQYawCommand.msg'), ('FIPAAclMessage', '/home/tompe/lrs_ws/src/lrs_msgs/msg/FIPAAclMessage.msg'), ('MPFlyingInfo', '/home/tompe/lrs_ws/src/lrs_msgs/msg/MPFlyingInfo.msg')]
[]
copying /opt/ros/hydro/lib/python2.7/dist-packages/rosdoc_lite/templates/msg-styles.css to /home/tompe/lrs_ws/devel/doc/lrs_msgs/html/msg-styles.css
Done documenting lrs_msgs you can find your documentation here: /home/tompe/lrs_ws/devel/doc/lrs_msgs
Built target lrs_msgs_doc

Happened to use hydro here but same result and failure in groovy.