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

Avoid placing broken links to documentation on index listings #218

Open
hidmic opened this issue Jan 27, 2020 · 0 comments · May be fixed by #219
Open

Avoid placing broken links to documentation on index listings #218

hidmic opened this issue Jan 27, 2020 · 0 comments · May be fixed by #219
Assignees
Labels
bug Something isn't working

Comments

@hidmic
Copy link

hidmic commented Jan 27, 2020

The fact that we do not have infrastructure to generate API documentation for ROS2 packages yet results in most documentation links in index pages for said packages to be broken. See ros2/rclcpp#958 and ros2/ros_core_documentation#16 for existing evidence.

rosindex is currently putting together URIs with no regard for whether these actually refer to existing sites or not (e.g. here). As a short term solution, we should avoid doing so. We can test URIs during index generation OR simply not generate them for ROS2 packages at all.

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

Successfully merging a pull request may close this issue.

1 participant