pull-request.yaml

name: "Pull Request Docs Check"

on: 
- pull_request

jobs:           
  build-pdf:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Repository  
        uses: actions/checkout@v3
        
      - name: Refresh Packages
        run: sudo apt-fast -y update
        
      - name: Install Dependencies
        run: xargs -a dependencies sudo apt-fast install -y

      - name: Python Setup
        uses: actions/setup-python@v4
        with:
          python-version: 3.8
          cache: 'pip'

      - name: Python Install Dependencies
        run: pip install -r docs/requirements.txt
        
      - name: Build PDF
        env:
          SPHINXOPTS: "-D html_context.commit=${{ github.sha }} -D version=latest -A display_github=true -A github_user=${{ github.repository_owner }} -A github_repo=${{ github.event.repository.name }} -A github_version=${{ github.ref_name }} -A conf_py_path=/docs/source/"
        run: make -C docs/ latexpdf
        
      - name: Archive PDF
        env:
          PR_NUMBER: ${{ github.event.number }}
          ID:  ${{ github.run_attempt }}
        uses: actions/upload-artifact@v3
        with:
          name: FTCDOCS-PDF
          path: |
            docs/build/latex/*.pdf
            FTCDOCS-PR-${{ env.PR_NUMBER }}-${{ env.ID }} 
          if-no-files-found: error

  build-html:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Repository  
        uses: actions/checkout@v3
        
      - name: Refresh Packages
        run: sudo apt-fast -y update

      - name: Python Setup
        uses: actions/setup-python@v4
        with:
          python-version: 3.8
          cache: 'pip'

      - name: Python Install Dependencies
        run: pip install -r docs/requirements.txt
        
      - name: Build Site
        env:
          SPHINXOPTS: "-D html_context.commit=${{ github.sha }} -D version=latest -A display_github=true -A github_user=${{ github.repository_owner }} -A github_repo=${{ github.event.repository.name }} -A github_version=${{ github.ref_name }} -A conf_py_path=/docs/source/"
        run: make -C docs/ html
          
      - name: Archive Site
        uses: actions/upload-artifact@v3
        with:
          name: FTCDOCS-HTML
          path: 'docs/build/html'
          if-no-files-found: error
          
  spelling-check:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Repository  
        uses: actions/checkout@v3
        
      - uses: reviewdog/action-misspell@v1
        with:
          locale: "US"
          reporter: "github-check"

  link-check:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Repository  
        uses: actions/checkout@v3

      - name: Python Setup
        uses: actions/setup-python@v4
        with:
          python-version: 3.8
          cache: 'pip'

      - name: Python Install Dependencies
        run: pip install -r docs/requirements.txt

      - name: link-check
        run: make -C docs/ linkcheck SPHINXOPTS="-W --keep-going -n -q"

      - name: Archive Log
        if: ${{ failure() }}
        uses: actions/upload-artifact@v2
        env:
          PR_NUMBER: ${{ github.event.number }}
          ID:  ${{ github.run_attempt }}
        with:
          name: LINKCHECK
          path: docs/build/linkcheck/output.txt
          retention-days: 7

  image-check:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Repository  
        uses: actions/checkout@v3

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

      - name: Python Install Dependencies
        run: pip install -r docs/requirements.txt

      - name: image-check
        run: make -C docs/ imagecheck