test.yml

# documentation: https://help.github.com/en/articles/workflow-syntax-for-github-actions
name: build tutorial
on: [push, pull_request]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - name: checkout
      uses: actions/checkout@v3

    - name: set up Python
      uses: actions/setup-python@v4
      with:
        python-version: 3.8

    - name: Codespell action
      uses: codespell-project/actions-codespell@master
      with:
        check_filenames: true
        # Ignore a listed standard mistake in CodeSpell by listing it in the same case that it appears in that list
        # See https://github.com/codespell-project/codespell/blob/v2.2.1/codespell_lib/data/dictionary.txt
        ignore_words_list: UES,ues
        uri_ignore_words_list: UES,ues

    #- name: Markdown Linting Action
    #  uses: avto-dev/markdown-lint@v1.2.0
    #  with:
        # rules: '/lint/rules/changelog.js'
        # config: '/lint/config/changelog.yml'
    #    args: '.'

    - name: install mkdocs
      run: |
          pip install mkdocs mkdocs-material mkdocs-redirects mkdocs-git-revision-date-localized-plugin
          mkdocs --version

    - name: build tutorial
      run: mkdocs build --strict