Skip to content

doc: update project README #9

doc: update project README

doc: update project README #9

Workflow file for this run

name: Rust
on:
push:
branches: [ "master" ]
pull_request:
branches: [ "master" ]
env:
CARGO_TERM_COLOR: always
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Build
run: cargo build -v
- name: Run tests
run: cargo test -v
- name: Build Documentation
run: cargo doc --no-deps
# Redirect / to /strontium/ to render the documentation in the page root.
- name: Create Redirect Index
run: echo '<meta http-equiv="refresh" content="0; URL='./strontium/'" />' >> target/doc/index.html
- name: Publish Documentation
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./target/doc