documentation.yml

name: Generate Documentation

on:
  push:
    branches:
      - master 

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Set up Python
        uses: actions/setup-python@v2
        with:
          python-version: 3.x  # Change to your Python version if necessary

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt 
          pip install sphinx sphinx-rtd-theme

      - name: Build Sphinx documentation
        run: |
          sphinx-quickstart --quiet --sep --no-makefile --dot _ --suffix .rst --master index --ext-autodoc --ext-viewcode --ext-doctest docs --project "Hammy McHamilon" --author "Joshua Clarke and Antony Bailey"
          mv README.MD docs
          sphinx-build -b html docs docs/_build
        working-directory: ${{ github.workspace }}
      - name: Deploy documentation
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs/_build/html