documentation.yml

# This is a basic workflow to help you get started with Actions

name: documentation

# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the master branch
on:
  push:
    branches: [ master ]

jobs:
  document:
    runs-on: ubuntu-latest

    env:
      RUSTDOCFLAGS: -D warnings

    steps:
      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
      - uses: actions/checkout@v2

      # temporary: set toolchain to nightly, so intra-doc links work
      - name: Install nightly rust
        run: |
          rustup toolchain install nightly
          rustup default nightly
      
      - name: Generate Documentation
        run: cargo doc --no-deps --verbose --document-private-items
      
      - name: GitHub Pages action
        # You may pin to the exact commit or the version.
        # uses: peaceiris/actions-gh-pages@3bdd7da7d7d089f3323b0d9f6fdcd59d492a2541
        uses: peaceiris/actions-gh-pages@v3.7.0
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./target/doc