docs.yml

name: Publish docs

on:
  push:
    branches:
      - main

jobs:
  docs:
    name: Publish docs
    runs-on: ubuntu-latest

    steps:
      - name: Checkout sources
        uses: actions/checkout@v2

      - name: Install toolchain
        uses: actions-rs/toolchain@v1
        with:
          toolchain: nightly
          profile: minimal
          override: true

      - name: Build docs
        # enable again when crate is done
        #env:
        #  RUSTDOCFLAGS: --cfg docsrs -D rustdoc::broken_intra_doc_links
        run: |
          cargo +nightly doc --no-deps --all-features
        # TODO: have this option point to Botanist's code for examples
        # ` -Z rustdoc-scrape-examples=examples`
        # maybe fetching the sources then pointing to that folder?
      - name: Move files
        shell: bash
        run: |
          DIR=${GITHUB_REF#refs/heads/}
          mkdir -p ./docs/$DIR
          mv ./target/doc/* ./docs/$DIR/
      - name: Deploy docs
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_branch: gh-pages
          publish_dir: ./docs
          allow_empty_commit: false
          keep_files: true