Skip to main content

Questions tagged [documentation]

The tag has no usage guidance.

Filter by
Sorted by
Tagged with
0 votes
1 answer
25 views

Where to find full ROS2 API documentation?

I'm a ROS 1 veteran and am currently working on my first serious ROS 2 project. I'm having trouble figuring out the details of the how the documentation is laid out. I'll provide a specific example to ...
Airuno2L's user avatar
  • 306
0 votes
1 answer
42 views

Access Issue to navigation2 Documentation Website. Is website off?

I am experiencing issues accessing the navigation2 documentation website at navigation.ros.org. When attempting to access the site, I receive a DNS error: "DNS_PROBE_FINISHED_NXDOMAIN." ...
Marcus Vinicius's user avatar
0 votes
1 answer
49 views

openssl version for ROS2 humble Win10

I am following the ROS 2 Humble documentation and it is required openssl v1.1.1t. In the official website I cannot find that versione cause EOL. How can I install it?
Robowave's user avatar
0 votes
2 answers
42 views

ArduPilot plugin for gazebo documentation

i'm trying to simulate a cessna 172 using Gazebo garden, and i'd like to control it within the simulation using the ArduPilot plugin. I've seen on the official websites some examples using the zephyr ...
Yogn's user avatar
  • 1
1 vote
2 answers
660 views

No module named 'catkin_pkg' when installing ROS 2 Iron in a conda environment for MacOS

I'm trying to install ROS 2 Iron into a new conda environment on my Mac (ARM architecture). I was following the instructions in this documentation but when I run ...
jkelle's user avatar
  • 11
0 votes
1 answer
77 views

ROS2 Humble API documentation

Hello, Can anyone point me to the ROS2 Humble API documentation? I found ROS2 API documentation for past distributions at https://docs.ros2.org, e.g.: https://docs.ros2.org/foxy/api/ https://docs.ros2....
JRTG's user avatar
  • 2,074
0 votes
1 answer
4 views

wiki ROS in Arabic

How to add a new language (Arabic) to the main documentation page at http://wiki.ros.org/ so we can add more tutorials for Arabs users. I want to work on a translation for the main documentation. ...
user avatar
0 votes
1 answer
2 views

Releasing packages with bloom, what can go in the "doc" field?

When running bloom-release on a repository I'm trying to release, bloom asks for a link to the documentation. Upon inspection of distribution.yaml, it seems that ...
ijnek's user avatar
  • 308
0 votes
1 answer
12 views

[ROS2] Python launch documentation

Hi, Is there comprehensive documentation regarding ROS2's Python-based launch system? I found examples and many questions/replies here, but I cannot find complete documentation reporting all the ...
Myzhar's user avatar
  • 198
0 votes
1 answer
8 views

Confusion regarding mx, my variables in costmap_2d::worldToMap method

The worldToMap function is defined as follows in the official documentation - ...
skpro19's user avatar
  • 314
0 votes
1 answer
1 view

MsgSrvDoc links 404 on wiki: how to correct?

Hi, I've noticed in the wiki page of move_base that the links to the message documentation are broken (404). They lead to ...
user avatar
0 votes
1 answer
2 views

docs.ros.org down/broken?

docs.ros.org seems to be broken. For example here is the link for the AsyncSpinner for melodic (I get a 404): http://docs.ros.org/melodic/api/roscpp/html/classros_1_1AsyncSpinner.html Originally ...
user avatar
0 votes
1 answer
37 views

How to build documentation for ROS2 packages?

Wondering how, e.g. rclpy, got it's documentation built (you can find it's crystal docs here so I can build documentation for submitted packages. There is nothing on the build farm indicative of a doc ...
user avatar
0 votes
1 answer
1 view

Doubt in documentation job

My pull request for indigo,melodic and lunar were merged two days ago for addition in documentation index. Melodic and indigo documentation appears on ROS Wiki but lunar does not appear. http://wiki....
user avatar
0 votes
1 answer
10 views

difference of ros2 demos and ros2 examples

trying to work myself through the tutorials for ROS2 so I am new to it Sometimes tutorials refer to ros2 demos and sometimes to ros2 examples and both are actively used. Is that a historically grown ...
user avatar
0 votes
1 answer
1 view

Indexing Metapackage wiki.ros.org

Hi, I read the tutorial on indexing of the packages (http://wiki.ros.org/rosdistro/Tutorials/Indexing%20Your%20ROS%20Repository%20for%20Documentation%20Generation) If I release a metapackage do I have ...
user avatar
0 votes
2 answers
12 views

Where's the official Python API documentation for TF?

The web article http://wiki.ros.org/tf only seems to point to the C++ API documentation (e.g. the following sub-article http://wiki.ros.org/tf/Overview/Data%20Types only contains C++ examples). I ...
user avatar
0 votes
1 answer
4 views

What exactly is a target in the context of ROS, catkin and workspaces?

I have seen the word "target" used in different articles, but I have not seen a clear definition of it. For example, this article http://wiki.ros.org/eros/Tutorials/Install%20Targets is ...
user avatar
0 votes
1 answer
34 views

Why do we need the devel, build and install spaces in a catkin workspace?

I have read the initial part of the article http://wiki.ros.org/catkin/workspaces, but I am still not having an intuitive understanding of why we need the devel, <...
user avatar
0 votes
1 answer
2 views

ROS documentation link redirects to wrong URL

Hello, since some days; I've noticed that the Documentation link from http://www.ros.org/news/ redirects me to a wrong URL. Clicking the link Documentation redirects me to an empty page http://www.ros....
user avatar
0 votes
1 answer
4 views

update ros wiki link to my package after renaming it

Hello to everyone. I have successfully added my package to rosdistro for indigo and kinetic. I renamed the directory name to match the package name I gave to it.. Should I do something more, so that ...
user avatar
0 votes
1 answer
1 view

Documentation of stack not updating after being added to rosdistro/kinect.yaml

The problem: I followed the guidelines in Indexing Your ROS Repository for Documentation Generation and everything seemed to worked fine until the documentation page generation. The stack: ...
user avatar
0 votes
1 answer
1 view

Wiki stack/package overview

I upload many documentation for a project. But i have one problem. Hi, I also want have the overview of the packages in the wiki with are cohere with each other. Because my bad english one example. At ...
user avatar
0 votes
1 answer
70 views

Explanation of rospy.Rate()

I am looking for an explanation of rospy.rate(), I have looked it in the documentation and it says the following: Convenience class for sleeping in a loop at a ...
user avatar
0 votes
1 answer
5 views

sensor_msg:Imu format specification

Hi, I was confused by what data should go into the sensor_msg::Imu message. It has a field called linear_acceleration. The existing users and provider assume that it takes acceleration containing the ...
user avatar
0 votes
1 answer
3 views

How do I feature a book on wiki.ros.org/Books

Can someone help me create a book page like http://wiki.ros.org/Books/ROS_Robotics_By_Example to be posted on http://wiki.ros.org/Books to feature a book Originally posted by PacktPub on ROS Answers ...
user avatar
0 votes
1 answer
1 view

Where do I create a ticket for pid documentation?

[I'm returning to ROS for my latest robot project. I'm appreciating it greatly and want to participate in improving it. Right now I'm in an especially good position to report issues from a "new ...
user avatar
0 votes
1 answer
5 views

How do you document your ROS packages?

There are 100s of places where one can put documentation info about their ROS package code: <documentation> strings in ...
user avatar
0 votes
1 answer
1 view

How to use "MsgSrvDoc" in wiki

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 ...
user avatar
0 votes
1 answer
2 views

How is manifest.yaml generated?

I'm trying to understand and even improve rosdoc_lite and have a question... let's take roscpp as an example. Where is the landing page for http://docs.ros.org/indigo/api/roscpp/html/ generated from? ...
user avatar
0 votes
1 answer
1 view

Different documentation generated by rosdoc_lite online and offline

For the adhoc communication package or the explorer package the documentation generated online and offline, especially the Package Summary, looks different. While online Author, Status, Link are ...
user avatar
0 votes
1 answer
1 view

The documentation indexer error message gives an incorrect link

If my package is not found in rosdistro//doc.yaml, the wiki page displays a message like this: Cannot load information on name: razor_imu_9dof, distro: indigo, which means that it is not yet in our ...
user avatar
0 votes
1 answer
1 view

How to open custom wiki page subdomain (e.g. moveit.ros.org) and its experience

First, please don't get me wrong, I don't mean I want to open a custom domain. MoveIt! project uses moveit.ros.org for their wiki contents (that are stored on github according to @Dave Coleman) ...
IsaacS's user avatar
  • 4,502
0 votes
1 answer
1 view

I have found a simple link mistake in wiki documents. Where should I report

At the page http://www.ros.org/browse/details.php?distro=indigo&name=gazebo_ros the website link leading to help ros and gazebo integration is now directs to a unrelated place. The correct place ...
user avatar
0 votes
1 answer
3 views

Message Format or Description

Hello everyone, Is there a way we can know the description of the data that is logged for each topic ? For example the data logged to the topic /navsat/fix contains altitude ,longitude and latitude ...
user avatar
0 votes
1 answer
1 view

Where Can I find documentation on how to write drivers in ros?

I am new to ROS. I am trying to write differential drivers . Where can I find documentation ? Originally posted by Jackel Fox on ROS Answers with karma: 1 on 2014-05-26 Post score: 0
user avatar
0 votes
1 answer
3 views

ROS package release status

If a package's documentation status does not list a specific release does that mean it is not supported in that release? For example, I'm interested in potentially using executive_smach, but it is not ...
user avatar
0 votes
1 answer
11 views

ros::init API Documentation

I am having trouble finding the ros::init call in the documentation. I've followed a few of the tutorial links and tried searching through the documentation. Here ...
user avatar
0 votes
1 answer
1 view

How long does the wiki take to create package pages?

Currently waiting on several packages to be spidered for the wiki. For example, um6 and robot_upstart have both been in hydro/doc.yaml for almost three weeks with ...
user avatar
0 votes
1 answer
1 view

How to Indexing my *-ros-pkg Repository for Documentation Generation

I have create a wiki page for my ros package,but it shows that 'groovy: Cannot load information on name: wlkeyctrl, distro: groovy, which means that it is not yet in our index. Please see this page ...
user avatar
0 votes
1 answer
1 view

ROS and Gazebo: Documentation Soon?

Now that ROS and Gazebo are both under the umbrella of OSRF, when will we be getting updates to the ROS.org documentation of gazebo? The Gazebo website says "Only install Gazebo from here, and ...
DLu's user avatar
  • 4,294
0 votes
1 answer
5 views

Set TF_CACHE_TIME with rospy

Hello! I'm using a robotic (and ROSified!) wheelchair. One of the tasks I have to do is to transform a point from /base_link to ...
user avatar
0 votes
2 answers
1 view

rosdoc_lite issues

As rosdoc is deprecated, we've recently switched from rosdoc to rosdoc_lite for our private, internal documentation of not-ready-for-primetime packages. But the web docs created by rosdoc_lite seem to ...
user avatar
0 votes
1 answer
2 views

Issues with ar_pose documentation

Hi everyone, It seems like the repository link for ar_pose is wrong. I guess it might have something to do with jenkins... Right now it is associated with the kinton_robot stack, which seems ...
user avatar
0 votes
1 answer
2 views

[FR] Tags in package documentation

Hello! Unfortunately I didn't find how to post a feature-request for ros.org site, so post here. (this post is connected to my prev. question(http://answers.ros.org/question/51928/how-to-search-for-...
user avatar
0 votes
2 answers
2 views

Are there ROS API documents published, and where?

This seems like a stupid question, but I have honestly tried and failed to find any documentation for the ROS APIs. To better clarify, I'm coming from the Java world, where I can go to Oracle's ...
user avatar
0 votes
1 answer
6 views

Documenting parameters and nodes

Is there any standard way to generate documentation for nodes and parameters in a ros wiki like form? I tried with rosdoc but I'm getting only the doxygen documentation. Originally posted by ...
user avatar
0 votes
1 answer
1 view

How to make launch files?

Hi, I've been reading some examples of ROS programs, and one of my questions so far is how can I create the launch file I need for the purpose of my program?, what is the correct scheme?, where can I ...
user avatar
0 votes
1 answer
2 views

ROS tutorial on supporting and programming a useful custom robot

Is there a tutorial explaining, from start to finish, how to support a new robot in ROS, and configure it to actually do something? I have a very simple custom robot with an amd64-based architecture, ...
user avatar
0 votes
1 answer
2 views

Documentation/references on how ROS works internally?

Hey, I am doing a project for my Uni involving ROS and in one of the chapters of the thesis I should talk about the state-of-the-art of ROS (i.e. how it really works internally). Are there any ...
user avatar