Publish documentation to GitHub Pages

.github/workflows/ci.yml

@@ -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

README.md

@@ -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.
 

arci-gamepad-gilrs/README.md

@@ -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).
 

arci-gamepad-keyboard/README.md

@@ -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.
 

arci-ros/README.md

@@ -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.
 

arci-ros2/README.md

@@ -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.
 

arci-speak-audio/README.md

@@ -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.
 

arci-speak-cmd/README.md

@@ -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.
 

arci-urdf-viz/README.md

@@ -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).
 

arci/README.md

@@ -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.
 

openrr-apps/README.md

@@ -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
 

openrr-client/README.md

@@ -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
 

openrr-command/README.md

@@ -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
 

openrr-config/README.md

@@ -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.
 

openrr-gui/README.md

@@ -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
 

openrr-planner/README.md

@@ -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.

openrr-plugin/README.md

@@ -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.
 

openrr-remote/README.md

@@ -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.
 

openrr-sleep/README.md

@@ -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
 

openrr-teleop/README.md

@@ -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