Ask Your Question
1

How to use "MsgSrvDoc" in wiki

asked 2015-06-11 08:30:21 -0500

updated 2015-06-11 08:30:54 -0500

Hello, I have a wiki page for my messages and services but it doesn't work the "MsgSrvDoc" label when I used in a wiki page.

I based the structure of my package and the wiki page on common_msgs repo.

So, my question is, why is it not working in the wiki page I created?

Thanks.

edit retag flag offensive close merge delete

2 Answers

Sort by ยป oldest newest most voted
2

answered 2015-06-11 13:12:06 -0500

William gravatar image

Basically the MsgSrvDoc macro is naive and always try's to go reference the package and .msg from the latest ROS distribution, in this case Jade. Since your package is not released for anything but Hydro, it does not find the file needed to generate the documentation.

The easiest work around for this would be to release your package for Jade (and while you're at it Indigo). This doesn't take very much time and should fix your issue.

However, this is a pretty serious limitation of the macro, I would recommend you open an issue against our roswiki repository:

https://github.com/ros-infrastructure...

I won't guarantee that we'll get around to addressing it in the near future, but at least the limitation will be captured and maybe someone else (maybe even yourself) can contribute a better macro.

edit flag offensive delete link more

Comments

Thanks for your quick answer @William. I have written the issue on GitHub. It could be fine if at least the macro is compatible with the LTS version of ROS and the last one. Because in this moment, we don't have in mind migrate our code to Jade, if any, we would think to migrate to Indigo.

raul.perula gravatar image raul.perula  ( 2015-06-12 04:14:19 -0500 )edit
0

answered 2015-06-15 15:04:11 -0500

tfoote gravatar image

For the MsgSrvDoc macro to work you must submit your package to be documented by the buildfarm to generate the content. Without being in the documentation index the website cannot render your information.

tutorial on adding your repo for documentation indexing

For reference the referenced ticket

edit flag offensive delete link more

Comments

Hi @tfoote, my pkgs with msgs are indexed and with a release in hydro version. But @William said the problem was that my pkgs are not in the last version of ROS, that is, in Jade. Is it right?

raul.perula gravatar image raul.perula  ( 2015-06-16 02:19:09 -0500 )edit

I misspoke, you don't have to have them released, just registered for documentation. You should be able to easily add them for documentation (tutorial linked above) without spending anytime "migrating" them to work on Jade.

William gravatar image William  ( 2015-06-16 13:18:29 -0500 )edit

@William I have my packages registered for documentation in rosdistro repo, but only for the hydro version. Is it that right then?

raul.perula gravatar image raul.perula  ( 2015-06-16 14:08:06 -0500 )edit
1

No, you need the doc entry for the newer distro as well. It is not sufficient to have a doc entry for Hydro only with this wiki macro. If this wiki macro is improved it would be sufficient, but until them you'll need to register it for documentation for Jade as well.

William gravatar image William  ( 2015-06-16 14:44:45 -0500 )edit

Your Answer

Please start posting anonymously - your entry will be published after you log in or create a new account.

Add Answer

Question Tools

2 followers

Stats

Asked: 2015-06-11 08:30:21 -0500

Seen: 87 times

Last updated: Jun 15 '15