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

Publish documentation to GitHub Pages #617

Merged
merged 1 commit into from
Jun 14, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 8 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -309,6 +309,14 @@ jobs:
- uses: Swatinem/rust-cache@v1
- run: ci/ubuntu-install-dependencies.sh
- run: cargo doc --workspace --all-features --exclude arci-ros2
- name: Publish documentation
run: |
cd target/doc
git init
git add .
git -c user.name='ci' -c user.email='ci' commit -m 'Deploy OpenRR API documentation'
git push -f -q https://git:${{ secrets.github_token }}@github.com/${{ github.repository }} HEAD:gh-pages
if: github.event_name == 'push' && github.event.ref == 'refs/heads/main' && github.repository_owner == 'openrr'

shellcheck:
runs-on: ubuntu-latest
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# openrr: `Open Rust Robotics`

![Build and Test](https://github.com/openrr/openrr/workflows/Build%20and%20Test/badge.svg) [![crates.io](https://img.shields.io/crates/v/openrr.svg)](https://crates.io/crates/openrr) [![codecov](https://codecov.io/gh/openrr/openrr/branch/main/graph/badge.svg?token=28GTOOT4RY)](https://codecov.io/gh/openrr/openrr) [![docs](https://docs.rs/openrr/badge.svg)](https://docs.rs/openrr)
![Build and Test](https://github.com/openrr/openrr/workflows/Build%20and%20Test/badge.svg) [![crates.io](https://img.shields.io/crates/v/openrr.svg)](https://crates.io/crates/openrr) [![codecov](https://codecov.io/gh/openrr/openrr/branch/main/graph/badge.svg?token=28GTOOT4RY)](https://codecov.io/gh/openrr/openrr) [![docs](https://docs.rs/openrr/badge.svg)](https://docs.rs/openrr) [![docs](https://img.shields.io/badge/docs-main-blue)](https://openrr.github.io/openrr/openrr)

OpenRR (pronounced like "opener") is Open Rust Robotics platform.

Expand Down
2 changes: 1 addition & 1 deletion arci-gamepad-gilrs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# arci-gamepad-gilrs

[![crates.io](https://img.shields.io/crates/v/arci-gamepad-gilrs.svg)](https://crates.io/crates/arci-gamepad-gilrs) [![docs](https://docs.rs/arci-gamepad-gilrs/badge.svg)](https://docs.rs/arci-gamepad-gilrs)
[![crates.io](https://img.shields.io/crates/v/arci-gamepad-gilrs.svg)](https://crates.io/crates/arci-gamepad-gilrs) [![docs](https://docs.rs/arci-gamepad-gilrs/badge.svg)](https://docs.rs/arci-gamepad-gilrs) [![docs](https://img.shields.io/badge/docs-main-blue)](https://openrr.github.io/openrr/arci-gamepad-gilrs)

[`arci::Gamepad`](https://docs.rs/arci/*/arci/trait.Gamepad.html) implementation using [gilrs](https://gitlab.com/gilrs-project/gilrs).

Expand Down
2 changes: 1 addition & 1 deletion arci-gamepad-keyboard/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# arci-gamepad-keyboard

[![crates.io](https://img.shields.io/crates/v/arci-gamepad-keyboard.svg)](https://crates.io/crates/arci-gamepad-keyboard) [![docs](https://docs.rs/arci-gamepad-keyboard/badge.svg)](https://docs.rs/arci-gamepad-keyboard)
[![crates.io](https://img.shields.io/crates/v/arci-gamepad-keyboard.svg)](https://crates.io/crates/arci-gamepad-keyboard) [![docs](https://docs.rs/arci-gamepad-keyboard/badge.svg)](https://docs.rs/arci-gamepad-keyboard) [![docs](https://img.shields.io/badge/docs-main-blue)](https://openrr.github.io/openrr/arci-gamepad-keyboard)

[`arci::Gamepad`](https://docs.rs/arci/*/arci/trait.Gamepad.html) implementation for keyboard.

Expand Down
2 changes: 1 addition & 1 deletion arci-ros/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# arci-ros

[![crates.io](https://img.shields.io/crates/v/arci-ros.svg)](https://crates.io/crates/arci-ros) [![docs](https://docs.rs/arci-ros/badge.svg)](https://docs.rs/arci-ros)
[![crates.io](https://img.shields.io/crates/v/arci-ros.svg)](https://crates.io/crates/arci-ros) [![docs](https://docs.rs/arci-ros/badge.svg)](https://docs.rs/arci-ros) [![docs](https://img.shields.io/badge/docs-main-blue)](https://openrr.github.io/openrr/arci-ros)

ROS1 implementation for arci.

Expand Down
2 changes: 1 addition & 1 deletion arci-ros2/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# arci-ros2

[![crates.io](https://img.shields.io/crates/v/arci-ros2.svg)](https://crates.io/crates/arci-ros2) [![docs](https://docs.rs/arci-ros2/badge.svg)](https://docs.rs/arci-ros2)
[![crates.io](https://img.shields.io/crates/v/arci-ros2.svg)](https://crates.io/crates/arci-ros2) [![docs](https://docs.rs/arci-ros2/badge.svg)](https://docs.rs/arci-ros2) [![docs](https://img.shields.io/badge/docs-main-blue)](https://openrr.github.io/openrr/arci-ros2)

ROS2 implementation for arci.

Expand Down
2 changes: 1 addition & 1 deletion arci-speak-audio/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# arci-speak-audio

[![crates.io](https://img.shields.io/crates/v/arci-speak-audio.svg)](https://crates.io/crates/arci-speak-audio) [![docs](https://docs.rs/arci-speak-audio/badge.svg)](https://docs.rs/arci-speak-audio)
[![crates.io](https://img.shields.io/crates/v/arci-speak-audio.svg)](https://crates.io/crates/arci-speak-audio) [![docs](https://docs.rs/arci-speak-audio/badge.svg)](https://docs.rs/arci-speak-audio) [![docs](https://img.shields.io/badge/docs-main-blue)](https://openrr.github.io/openrr/arci-speak-audio)

[`arci::Speaker`](https://docs.rs/arci/*/arci/trait.Speaker.html) implementation for playing audio files.

Expand Down
2 changes: 1 addition & 1 deletion arci-speak-cmd/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# arci-speak-cmd

[![crates.io](https://img.shields.io/crates/v/arci-speak-cmd.svg)](https://crates.io/crates/arci-speak-cmd) [![docs](https://docs.rs/arci-speak-cmd/badge.svg)](https://docs.rs/arci-speak-cmd)
[![crates.io](https://img.shields.io/crates/v/arci-speak-cmd.svg)](https://crates.io/crates/arci-speak-cmd) [![docs](https://docs.rs/arci-speak-cmd/badge.svg)](https://docs.rs/arci-speak-cmd) [![docs](https://img.shields.io/badge/docs-main-blue)](https://openrr.github.io/openrr/arci-speak-cmd)

[`arci::Speaker`](https://docs.rs/arci/*/arci/trait.Speaker.html) implementation using local command.

Expand Down
2 changes: 1 addition & 1 deletion arci-urdf-viz/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# arci-urdf-viz

[![crates.io](https://img.shields.io/crates/v/arci-urdf-viz.svg)](https://crates.io/crates/arci-urdf-viz) [![docs](https://docs.rs/arci-urdf-viz/badge.svg)](https://docs.rs/arci-urdf-viz)
[![crates.io](https://img.shields.io/crates/v/arci-urdf-viz.svg)](https://crates.io/crates/arci-urdf-viz) [![docs](https://docs.rs/arci-urdf-viz/badge.svg)](https://docs.rs/arci-urdf-viz) [![docs](https://img.shields.io/badge/docs-main-blue)](https://openrr.github.io/openrr/arci-urdf-viz)

arci implementation using [urdf-viz](https://github.com/openrr/urdf-viz).

Expand Down
2 changes: 1 addition & 1 deletion arci/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# arci

[![crates.io](https://img.shields.io/crates/v/arci.svg)](https://crates.io/crates/arci) [![docs](https://docs.rs/arci/badge.svg)](https://docs.rs/arci)
[![crates.io](https://img.shields.io/crates/v/arci.svg)](https://crates.io/crates/arci) [![docs](https://docs.rs/arci/badge.svg)](https://docs.rs/arci) [![docs](https://img.shields.io/badge/docs-main-blue)](https://openrr.github.io/openrr/arci)

Abstract Robot Control Interface.

Expand Down
2 changes: 1 addition & 1 deletion openrr-apps/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# OpenRR applications

[![crates.io](https://img.shields.io/crates/v/openrr-apps.svg)](https://crates.io/crates/openrr-apps) [![docs](https://docs.rs/openrr-apps/badge.svg)](https://docs.rs/openrr-apps)
[![crates.io](https://img.shields.io/crates/v/openrr-apps.svg)](https://crates.io/crates/openrr-apps) [![docs](https://docs.rs/openrr-apps/badge.svg)](https://docs.rs/openrr-apps) [![docs](https://img.shields.io/badge/docs-main-blue)](https://openrr.github.io/openrr/openrr-apps)

## Prepare

Expand Down
2 changes: 1 addition & 1 deletion openrr-client/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# openrr-client

[![crates.io](https://img.shields.io/crates/v/openrr-client.svg)](https://crates.io/crates/openrr-client) [![docs](https://docs.rs/openrr-client/badge.svg)](https://docs.rs/openrr-client)
[![crates.io](https://img.shields.io/crates/v/openrr-client.svg)](https://crates.io/crates/openrr-client) [![docs](https://docs.rs/openrr-client/badge.svg)](https://docs.rs/openrr-client) [![docs](https://img.shields.io/badge/docs-main-blue)](https://openrr.github.io/openrr/openrr-client)

## License

Expand Down
2 changes: 1 addition & 1 deletion openrr-command/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# openrr-command

[![crates.io](https://img.shields.io/crates/v/openrr-command.svg)](https://crates.io/crates/openrr-command) [![docs](https://docs.rs/openrr-command/badge.svg)](https://docs.rs/openrr-command)
[![crates.io](https://img.shields.io/crates/v/openrr-command.svg)](https://crates.io/crates/openrr-command) [![docs](https://docs.rs/openrr-command/badge.svg)](https://docs.rs/openrr-command) [![docs](https://img.shields.io/badge/docs-main-blue)](https://openrr.github.io/openrr/openrr-command)

## License

Expand Down
2 changes: 1 addition & 1 deletion openrr-config/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# OpenRR Config

[![crates.io](https://img.shields.io/crates/v/openrr-config.svg)](https://crates.io/crates/openrr-config) [![docs](https://docs.rs/openrr-config/badge.svg)](https://docs.rs/openrr-config)
[![crates.io](https://img.shields.io/crates/v/openrr-config.svg)](https://crates.io/crates/openrr-config) [![docs](https://docs.rs/openrr-config/badge.svg)](https://docs.rs/openrr-config) [![docs](https://img.shields.io/badge/docs-main-blue)](https://openrr.github.io/openrr/openrr-config)

Utilities for modifying configuration files.

Expand Down
2 changes: 1 addition & 1 deletion openrr-gui/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# OpenRR GUI

[![crates.io](https://img.shields.io/crates/v/openrr-gui.svg)](https://crates.io/crates/openrr-gui) [![docs](https://docs.rs/openrr-gui/badge.svg)](https://docs.rs/openrr-gui)
[![crates.io](https://img.shields.io/crates/v/openrr-gui.svg)](https://crates.io/crates/openrr-gui) [![docs](https://docs.rs/openrr-gui/badge.svg)](https://docs.rs/openrr-gui) [![docs](https://img.shields.io/badge/docs-main-blue)](https://openrr.github.io/openrr/openrr-gui)

## Troubleshooting

Expand Down
2 changes: 1 addition & 1 deletion openrr-planner/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# OpenRR Planner

[![crates.io](https://img.shields.io/crates/v/openrr-planner.svg)](https://crates.io/crates/openrr-planner) [![docs](https://docs.rs/openrr-planner/badge.svg)](https://docs.rs/openrr-planner)
[![crates.io](https://img.shields.io/crates/v/openrr-planner.svg)](https://crates.io/crates/openrr-planner) [![docs](https://docs.rs/openrr-planner/badge.svg)](https://docs.rs/openrr-planner) [![docs](https://img.shields.io/badge/docs-main-blue)](https://openrr.github.io/openrr/openrr-planner)

Collision Avoidance Path Planning for robotics in Rust-lang.
This starts as a copy of [`gear`](https://github.com/openrr/gear) crate.
Expand Down
2 changes: 1 addition & 1 deletion openrr-plugin/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# OpenRR Plugin

[![crates.io](https://img.shields.io/crates/v/openrr-plugin.svg)](https://crates.io/crates/openrr-plugin) [![docs](https://docs.rs/openrr-plugin/badge.svg)](https://docs.rs/openrr-plugin)
[![crates.io](https://img.shields.io/crates/v/openrr-plugin.svg)](https://crates.io/crates/openrr-plugin) [![docs](https://docs.rs/openrr-plugin/badge.svg)](https://docs.rs/openrr-plugin) [![docs](https://img.shields.io/badge/docs-main-blue)](https://openrr.github.io/openrr/openrr-plugin)

Plugin support for arci.

Expand Down
2 changes: 1 addition & 1 deletion openrr-remote/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# OpenRR Remote

[![crates.io](https://img.shields.io/crates/v/openrr-remote.svg)](https://crates.io/crates/openrr-remote) [![docs](https://docs.rs/openrr-remote/badge.svg)](https://docs.rs/openrr-remote)
[![crates.io](https://img.shields.io/crates/v/openrr-remote.svg)](https://crates.io/crates/openrr-remote) [![docs](https://docs.rs/openrr-remote/badge.svg)](https://docs.rs/openrr-remote) [![docs](https://img.shields.io/badge/docs-main-blue)](https://openrr.github.io/openrr/openrr-remote)

Remote execution support for arci.

Expand Down
2 changes: 1 addition & 1 deletion openrr-sleep/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# openrr-sleep

[![crates.io](https://img.shields.io/crates/v/openrr-sleep.svg)](https://crates.io/crates/openrr-sleep) [![docs](https://docs.rs/openrr-sleep/badge.svg)](https://docs.rs/openrr-sleep)
[![crates.io](https://img.shields.io/crates/v/openrr-sleep.svg)](https://crates.io/crates/openrr-sleep) [![docs](https://docs.rs/openrr-sleep/badge.svg)](https://docs.rs/openrr-sleep) [![docs](https://img.shields.io/badge/docs-main-blue)](https://openrr.github.io/openrr/openrr-sleep)

## License

Expand Down
2 changes: 1 addition & 1 deletion openrr-teleop/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# openrr-teleop

[![crates.io](https://img.shields.io/crates/v/openrr-teleop.svg)](https://crates.io/crates/openrr-teleop) [![docs](https://docs.rs/openrr-teleop/badge.svg)](https://docs.rs/openrr-teleop)
[![crates.io](https://img.shields.io/crates/v/openrr-teleop.svg)](https://crates.io/crates/openrr-teleop) [![docs](https://docs.rs/openrr-teleop/badge.svg)](https://docs.rs/openrr-teleop) [![docs](https://img.shields.io/badge/docs-main-blue)](https://openrr.github.io/openrr/openrr-teleop)

## License

Expand Down