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

ReadtheDocs page is missing a lot of documentation for API. #1200

Open
guzman109 opened this issue Nov 16, 2023 · 8 comments
Open

ReadtheDocs page is missing a lot of documentation for API. #1200

guzman109 opened this issue Nov 16, 2023 · 8 comments
Labels
bug Something isn't working

Comments

@guzman109
Copy link

No Node API's found or even a link where to find them.

@clalancette
Copy link
Contributor

Sorry, can you be more clear about what link you are looking at?

@guzman109
Copy link
Author

I went to the one for iron.
https://docs.ros.org/en/iron/p/rclpy/api/node.html

@guzman109
Copy link
Author

https://docs.ros.org/en/iron/API-Docs.html

Also, there was no easy way of finding the python docs either, since they were not posted on here.

@clalancette
Copy link
Contributor

Also, there was no easy way of finding the python docs either, since they were not posted on here.

That page is not meant to be a listing of all documentation. The correct way to find the API docs is through https://index.ros.org, and doing a search for the package you are interested in. In this case, it would lead to https://index.ros.org/p/rclpy/github-ros2-rclpy/#iron, and there is a link to API Docs there.

@sloretz
Copy link
Contributor

sloretz commented Nov 17, 2023

Following the links from index.ros.org I get to the same page https://docs.ros.org/en/iron/p/rclpy/api/node.html, which seems to have no content for the Node class.

Comparing a page that does have content with one that doesn't work; the content looks about the same to me:

Seems like the rclpy.node module (and others) fails to be imported in the doc job

https://build.ros2.org/job/Idoc__rclpy__ubuntu_jammy_amd64/11/console

03:53:33 WARNING: Failed to import rclpy.node.
03:53:33 Possible hints:
03:53:33 * AttributeError: module 'rclpy' has no attribute 'node'
03:53:33 * ModuleNotFoundError: No module named 'type_description_interfaces'

@sloretz sloretz added the bug Something isn't working label Nov 17, 2023
@dghw
Copy link

dghw commented Jul 19, 2024

This issue is still happening today (e.g. at http://docs.ros.org/en/jazzy/p/rclpy/ most entries are pretty much empty).

Building the docs locally from source as described in the package readme worked fine.

@fujitatomoya
Copy link
Collaborator

@dghw thanks for checking on this, i also confirmed that local build just works. (many warnings came up though...)

image

@sloretz i have no idea how often this doc CI runs, do you have any idea about this documentation build CI? CC: @clalancette

@sloretz
Copy link
Contributor

sloretz commented Aug 9, 2024

Linking ros-infrastructure/rosdoc2#68

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

5 participants