generateDocs.yml

name: Docs

on:
  push:
    branches:
      - master

jobs:
  deploy:
    runs-on: ubuntu-18.04
    steps:
      - uses: actions/checkout@v2

      - name: Setup Python
        uses: actions/setup-python@v2
        with:
          python-version: '3.9'

      - name: Upgrade pip
        run: |
          # install pip=>20.1 to use "pip cache dir"
          python3 -m pip install --upgrade pip

      - name: Get pip cache dir
        id: pip-cache
        run: echo "::set-output name=dir::$(pip cache dir)"

      - name: Cache dependencies
        uses: actions/cache@v2
        with:
          path: ${{ steps.pip-cache.outputs.dir }}
          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
          restore-keys: |
            ${{ runner.os }}-pip-

      - name: Install dependencies
        run: |
          pip install -e .
          pip install pdoc3

      - name: Generate python modules from the verification and validation results, will become verification and validation part of the documentation website
        run: |
          python3 ./MAPLEAF/Examples/V\&V/PrepVerificationWebsite.py

      - run: |
          pdoc --html --output-dir docs ./MAPLEAF --template-dir ./Resources/DocTemplate
          python3 ./MAPLEAF/Examples/V\&V/MovePlotsToDocumentationFolder.py
          mv ./docs/MAPLEAF/* ./docs
          rm -r ./docs/MAPLEAF

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_branch: documentation
          publish_dir: ./docs