Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Latest Doxygen docs does not seem to include all files #2103

Open
russkel opened this issue Feb 14, 2023 · 4 comments
Open

Latest Doxygen docs does not seem to include all files #2103

russkel opened this issue Feb 14, 2023 · 4 comments

Comments

@russkel
Copy link

russkel commented Feb 14, 2023

Expected behavior

Documentation of classes such as GenericSubscription should be in the documentation at https://docs.ros2.org/latest/api/rclcpp/

Actual behavior

Classes don't appear at all - not even in the class index: https://docs.ros2.org/latest/api/rclcpp/classes.html#letter_g

@jrutgeer
Copy link
Contributor

docs.ros2.org is deprecated. It does no longer point to the latest API info.
Links to the latest API (for any package, not just rclcpp) can be found from the corresponding package info page at the ROS Index. For rclcpp it's at https://docs.ros.org/en/humble/p/rclcpp/

The rclcpp README was fixed to reflect this info: see PR #2071

If you prefer the standard doxygen theme, I don´t know of another way than to download the source and manually run Doxygen, as described here. It's less of a hassle than you´d might expect.

@fujitatomoya
Copy link
Collaborator

related to ros2/ros2_documentation#3323

@russkel
Copy link
Author

russkel commented Feb 27, 2023

docs.ros2.org is deprecated. It does no longer point to the latest API info.

I didn't even realise there were two domains! Thanks @jrutgeer for enlightening me.

In which case, I change the point of this ticket, can we get docs.ros2.org to redirect to docs.ros.org?

@clalancette
Copy link
Contributor

In which case, I change the point of this ticket, can we get docs.ros2.org to redirect to docs.ros.org?

Once Foxy goes out of support in May, we will do this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants