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

Add repository url if missing #161

Merged
merged 1 commit into from
Dec 7, 2024
Merged

Conversation

rkent
Copy link
Contributor

@rkent rkent commented Nov 21, 2024

Currently, very few package authors actually set the package repository url, which is an official link in package.xml But in navigating documentation, it is very important to be able to move as smoothly as possible between the rosindex package entry, rosdoc2 entry, and the repo. The repo url is readily available in rosdistro, so this PR looks it up if missing, and adds it.

Note this requires that we know the currently active rosdistro, which is not something that can be discerned directly from the package source. So the PR looks for ROS_DISTRO in the environment, and uses that if found. I'm not sure if the build farm sets that or not for doc jobs, if not that will need to be done to support this.

This also adds a new level of complexity to rosdoc2, that it is now using external information downloaded from the internet instead of just the local repo information for its build. I have a certain reluctance to add that additional complexity, but I believe the link to the repo URL is really important in documentation, so I think it is worth adding this.

Signed-off-by: R. Kent James <[email protected]>
@rkent rkent requested review from audrow and tfoote as code owners November 21, 2024 20:12
@clalancette
Copy link
Contributor

I'm not sure if the build farm sets that or not for doc jobs, if not that will need to be done to support this.

It currently does not.

Copy link
Member

@tfoote tfoote left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding this here makes sense. It can hopefully fill in more by default.

We should think more about having ways to help integrate the documentation experience across sites with improved cross referencing based on the distro.

@tfoote tfoote merged commit 3341f21 into ros-infrastructure:main Dec 7, 2024
5 checks passed
@rkent rkent deleted the show-repo-url branch December 9, 2024 16:16
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

Successfully merging this pull request may close these issues.

3 participants