From bd6699faae43c3b9db3f9f07d7d4b0b74b98909b Mon Sep 17 00:00:00 2001 From: Raul Victor Trombin Date: Fri, 10 Nov 2023 15:35:37 -0300 Subject: [PATCH 1/2] github: action: docs: Move documentation from root to doc --- .github/workflows/action.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/action.yml b/.github/workflows/action.yml index acfcb8f..24dac14 100644 --- a/.github/workflows/action.yml +++ b/.github/workflows/action.yml @@ -34,6 +34,8 @@ jobs: override: true - name: Build docs run: cargo doc + - name: Move documentation + run: mkdir -p pages/doc87 && mv target/doc/* pages/doc/ - name: Deploy uses: peaceiris/actions-gh-pages@v3 if: ${{ github.ref == 'refs/heads/master' }} From 85b8c605e5fc30471d4503aeec38b029f5114f09 Mon Sep 17 00:00:00 2001 From: Raul Victor Trombin Date: Fri, 10 Nov 2023 15:36:31 -0300 Subject: [PATCH 2/2] Cargo: Update documentation link --- .github/workflows/action.yml | 4 ++-- Cargo.toml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/action.yml b/.github/workflows/action.yml index 24dac14..4b64dce 100644 --- a/.github/workflows/action.yml +++ b/.github/workflows/action.yml @@ -35,13 +35,13 @@ jobs: - name: Build docs run: cargo doc - name: Move documentation - run: mkdir -p pages/doc87 && mv target/doc/* pages/doc/ + 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 diff --git a/Cargo.toml b/Cargo.toml index 33cd24d..a64040b 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -4,7 +4,7 @@ version = "0.2.0" edition = "2021" license = "MIT" description = "A Rust library for interacting with the AK09915 magnetometer" -homepage = "https://docs.bluerobotics.com/AK09915-rs/ak09915_rs" +homepage = "https://docs.bluerobotics.com/AK09915-rs/doc/ak09915_rs" documentation = "https://docs.rs/ak09915_rs" repository = "https://github.com/bluerobotics/AK09915-rs" readme = "README.md"