docs_builder.yml

name: "📚 Documentation Builder"

on:
  push:
    branches: [ master ]
    paths:
      - 'docs/**/*'
      - '.github/workflows/docs_builder.yml'
      - 'requirements/documentation.txt'
      - 'RoofClassify/**/*.py'
    tags: "*"

env:
  PYTHON_VERSION: 3.9

jobs:
  build-docs:

    runs-on: ubuntu-latest

    steps:
    - name: Get source code
      uses: actions/checkout@v4

    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: ${{ env.PYTHON_VERSION }}
        cache: "pip"

    - name: Cache project dependencies (pip)
      uses: actions/cache@v4.2.0
      with:
        path: ~/.cache/pip
        key: ${{ runner.os }}-pip-${{ hashFiles('requirements/*.txt') }}
        restore-keys: |
          ${{ runner.os }}-pip-

    - name: Install project requirements
      run: |
        python -m pip install -U pip setuptools wheel
        python -m pip install -U -r requirements/documentation.txt

    - name: Build doc using Sphinx
      run: sphinx-build -b html -d docs/_build/cache -j auto -q docs docs/_build/html

    - name: Deploy to GitHub Pages
      run: |
        python -m pip install -U ghp-import
        ghp-import --force --no-history --no-jekyll --push docs/_build/html