Git Product home page Git Product logo

docs.ros2.org's Introduction

ROS 2 Documentation Site

The documentation generation lives on the doc_gen branch. This branch is a GitHub Pages repository for hosting the ROS 2 documentation.

docs.ros2.org's People

Contributors

ahcorde avatar cottsay avatar dhood avatar jacobperron avatar mjcarroll avatar mm318 avatar nnmm avatar nuclearsandwich avatar sloretz avatar wjwwood avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docs.ros2.org's Issues

Documentation about the constant `qos_profile_sensor_data` missing in `rclpy`

https://index.ros.org/doc/ros2/Releases/Release-Dashing-Diademata/#rclpy recommends using qos_profile_sensor_data for subscribers. I could not find qos_profile_sensor_data on the rclpy QoS doc page.

There are some constants along with qos_profile_sensor_data defined on https://github.com/ros2/rclpy/blob/22816b41f66bcdb20adcca0b92fb7c8149710297/rclpy/rclpy/qos.py#L421

It would be great that these convenient constants are included in the documentation. The developer's ignorance of qos_profile_sensor_data leads to code as follows:

self.subscription = self.create_subscription(
            LaserScan,
            'scan',
            self.listener_callback,
            QoSProfile(depth=10, reliability=ReliabilityPolicy.BEST_EFFORT))

As far as I understand the following does the same:

self.subscription = self.create_subscription(
            LaserScan,
            'scan',
            self.listener_callback,
            qos_profile_sensor_data)

Make message docs findable

There are no relevant results when Googling "sensor_msgs foxy ros2", not even for "site:docs.ros2.org sensor_msgs". The docs actually do exist at http://docs.ros2.org/foxy/api/sensor_msgs/index-msg.html, along with all the other official message packages. Nothing links to these pages or they would be indexed by Google, and even their URL is hard to guess (you might try index.html but not index-msg.html). index.ros.org also links to http://docs.ros2.org/foxy/api/sensor_msgs/ which gives a 404 error. So no one knows they exist and is left to guess whether the ROS1 docs still apply โ€“ including me until I looked at this repo.

I propose generating a http://docs.ros2.org/<distro>/api/index.html which lists all the packages, and linking to that one from the main http://docs.ros2.org/<distro>/index.html page. Additionally, either the name of the package documentation should be changed to index.html or the links in index.ros.org be adjusted.

I can take a stab at the first item although I don't really know Sphinx and Doxygen well, I'll let you know how it goes.

there is no top level LICENSE file

There is no top level LICENSE file.
What license are these docs under?
The CC-BY-4.0 license makes the most sense for docs like this.

Migrate docs.ros2.org into index.ros.org?

Hi,

I stumbled on this website and it seems that alot of the content here is a slightly different mirror of content that is either on the Index website or should be on the index website for ROS2 overviews.

Is the intent to have this be a separate website, or is this just content that didn't get migrated over? The ROS2 API diagrams are some of the key things on this website that I think should be reflected on the Index to beginners (e.g. http://docs.ros2.org/eloquent/developer_overview.html#internal-api-architecture-overview).

Edit: To be clear, I'm open to migrating this myself if that's in line with what folks think should be done.

Dead link in most (all?) quality declarations

Apologies in advance if this is the wrong place to post this fairly minor point, but I noticed that many (if not all) of the Quality Declaration files for core ROS packages have a dead link to a ROS2 Onboarding Guide.

Full excerpt from Coverage [4.iii]:
Current coverage statistics can be viewed here. A description of how coverage statistics are calculated is summarized in this page "ROS 2 Onboarding Guide".

A few examples:
rcl
rclcpp
rmw

Has this guide moved somewhere else or should the reference to it be removed altogether? Is there a better document that we should direct new users (like myself) to, to learn how coverage statistics are calculated?

Thanks!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.