docs.yml

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

name: Docs

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


  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  # This workflow contains a single job called "build"
  build:
    # The type of runner that the job will run on
    runs-on: ubuntu-latest

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
      - uses: actions/checkout@v2
      - name: Deploy docs
        uses: mhausenblas/mkdocs-deploy-gh-pages@master
        # Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      # - name: MkDocs Action
        # You may pin to the exact commit or the version.
        # uses: Tiryoh/actions-mkdocs@072eb4f9722aa46b8f730ba4c02fd29d63d96096
        # uses: Tiryoh/actions-mkdocs@v0.2.0
        #with:
          # pip version of MkDocs
          #mkdocs_version: # optional, default is latest
          # path to requirements.txt
          #requirements: # optional, default is requirements.txt
          # path to mkdocs.yml
          #configfile: # optional, default is mkdocs.yml