Skip to content

Update README.md

Update README.md #17

Workflow file for this run

name: Continuous Integration
on:
push:
branches:
- master
pull_request:
jobs:
doc:
name: Documentation on Github Pages
runs-on: ubuntu-22.04
steps:
- name: Checkout sources
uses: actions/checkout@v3
- name: Get date for registry cache
id: date
run: echo "::set-output name=date::$(date +'%Y-%m-%d')"
- name: Cargo registry cache
uses: actions/cache@v3
with:
path: |
~/.cargo/registry/index
~/.cargo/registry/cache
~/.cargo/git
key: ${{ runner.os }}-cargo-registry-${{ steps.date.outputs.date }}
restore-keys: ${{ runner.os }}-cargo-registry-
- name: Rust toolchain
uses: dtolnay/rust-toolchain@nightly
- name: Build Documentation
env:
RUSTDOCFLAGS: --cfg=docsrs
run: cargo doc --no-deps
- name: Setup index
run: cp ./doc_index.html ./target/doc/index.html
- name: Deploy
if: ${{ github.event_name == 'push' }}
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./target/doc
force_orphan: true