add docs for waitUntilNav2Active#275
Conversation
commander_api/index.rst
Outdated
| | | active state. To be used in conjunction with autostart or external | | ||
| | | lifecycle bringup. | | ||
| | waitUntilNav2Active( | Blocks until Nav2 is completely online and lifecycle nodes are in the | | ||
| | navigator='bt_navigator', | active state. To be used in conjunction with autostart or external | | |
There was a problem hiding this comment.
I think this is misformatted, the table isn't rendering in github's markdown view or in the rst website https://1251-240847415-gh.circle-artifacts.com/0/html/commander_api/index.html
There was a problem hiding this comment.
For some reason, in the artifacts waitUntilNav2Active is shown as bold. In an RST viewer I found online it looks fine.
How can I test it on the Read The Docs viewer?
There was a problem hiding this comment.
2 ways, you can compile it locally, see the ci config for the libraries to install and then you can invoke “make html” to make it. Then look in the build directory for the html’s entry index to view in a browser. Also, it you run it through CI, you can go to the artifacts tab and do the same thing with CI’s output build.
Docs for ros-navigation/navigation2#2811
Additionally fixed some extra white spaces