Skip to content

Add a job to build and deploy the main branch doc on Github pages #461

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

romainreignier
Copy link
Contributor

As proposed in #460, I suggest to host the doc of the git version of rclrs on Github pages.

In order for it to work, you need to enable Github Pages on this repo:
image

I understand @esteve point in #460 (comment) that people using the git version of rclrs can do cargo doc themselves because the doc is already published on doc.rs for the released version of the crate so feel free to decline my PR if you prefer.

But I my point was to ease the access to the documentation of the git version instead of adding simple examples that have the same content than the rustdoc snippets to reduce the maintenance effort on API changes.

The workflow was tested on my fork in the feature/add_doc_job with the result exposed here. I had to do a different branch for the PR to point to the main branch of this repo.

@esteve
Copy link
Collaborator

esteve commented Feb 27, 2025

@romainreignier fantastic, this is great! Thanks for the PR. I'll review it properly later today or tomorrow, but at first glance it looks good to me.

@romainreignier
Copy link
Contributor Author

The down side is that I have to build the full ros workspace to be able to run cargo doc. The job is then taking several minutes. Maybe adding this to another job would save some CPU time.

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.

2 participants