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.

Sign up for GitHub

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

github: action: docs: Move documentation from root to doc #60

Merged
merged 2 commits into from
Nov 7, 2023
Merged

github: action: docs: Move documentation from root to doc #60

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d61ac2
github: action: docs: Move documentation from root to doc
RaulTrombin Nov 6, 2023
90dce16
Cargo: Update documentation link
RaulTrombin Nov 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/workflows/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,14 @@ jobs:
override: true
- name: Build docs
run: cargo doc
- name: Move documentation
run: mkdir -p pages/doc && mv target/doc/* pages/doc/
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.ref == 'refs/heads/master' }}
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./target/doc
publish_dir: ./pages

deploy:
needs: build
Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ edition = "2021"
license = "MIT"
description = "This crate serves as the entry point for embedding applications using Rust on Blue Robotics's Navigator"
homepage = "https://bluerobotics.com/store/comm-control-power/control/navigator/"
documentation = "https://docs.bluerobotics.com/navigator-rs/navigator_rs/"
documentation = "https://docs.bluerobotics.com/navigator-rs/doc/navigator_rs/"
repository = "https://github.com/bluerobotics/navigator-rs"
categories = ["BlueRobotics", "Embedded development", "Science"]
keywords = ["BlueRobotics", "embedded", "navigator", "robotics", "ROV"]
Expand Down
Loading