gh-pages.yaml

name: Deploy Documentation to GitHub Pages

on:
  push:
    branches:
      - main
    
  pull_request:
    branches:
      - main

permissions:
  contents: write

jobs:
  build:
    runs-on: ubuntu-latest

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

    - name: Set up Python
      uses: actions/setup-python@v4
      with:
        python-version: '3.9'

    - name: Set up Pandoc
      run: |
        sudo apt-get update
        sudo apt-get install -y pandoc

    - name: Install dependencies
      run: |
        pip install sphinx sphinx-autodoc-typehints sphinx_book_theme sphinx-copybutton
        pip install nbsphinx recommonmark Pygments
        pip install pandoc

    - name: Build the docs
      run: |
        cd docs
        make html

    - name: Deploy to GitHub Pages
      if: github.event_name == 'push' && github.repository == 'microsoft/mattersim' && ( startsWith( github.ref, 'refs/tags/' ) || github.ref == 'refs/heads/main' )
      uses: peaceiris/actions-gh-pages@v3
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: ./docs/_build/html