documentation.yml

name: documentation

on:
  push:            # run on push events in the docs subfolder
    paths:
      - 'docs/**'
  workflow_dispatch:
  schedule:
  - cron: '30 1 * * *' # daily at 01:30 UTC

jobs:
  ############################
  # BUILDING THE DOCUMENTATION
  ############################
  build-and-internal-link-check:
    runs-on: ubuntu-latest

    steps:
    - name: Cloning repository
      uses: actions/checkout@v3

    - name: Installing plantuml
      run: |
        sudo apt-get update
        sudo apt-get install plantuml

    - name: Configuring Python
      uses: actions/setup-python@v4
      with:
        python-version: '3.x'

    - name: Installing pip packages
      run: |
        cd docs/web/
        python -m pip install --upgrade pip
        python -m pip install -r requirements.txt

    - name: Building documentation
      run: |
        cd docs/web/
        mkdocs build --strict


  ############################
  # CHECKING EXTERNAL LINKS
  ############################
  external-link-check:
    runs-on: ubuntu-latest

    steps:
    - name: Cloning repository
      uses: actions/checkout@v3

    - name: Checking links in markdown files
      uses: gaurav-nelson/github-action-markdown-link-check@v1
      with:
        config-file: 'docs/web/.link_check_config.json'
        use-quiet-mode: 'yes'
        use-verbose-mode: 'no'
        folder-path: 'docs/web/docs/'