docs.yml

name: Deploy Docs

on:
  push:
    branches:
      - master
#      - 'docs-**'
  pull_request:
    branches: 
      - 'master'

env:
  BASE_URL: /${{ github.event.repository.name }}

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  build:
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/checkout@v4
        with:
          submodules: false
          sparse-checkout: |
            .github
            docs

      - name: Set up Python 3.12
        uses: actions/setup-python@v5
        with:
          python-version: 3.12
          cache: 'pip'

      - name: Install dependencies
        run:  pip install -r ${GITHUB_WORKSPACE}/docs/requirements.txt

      - name: Build TSMP2 doc homepage
        working-directory: ./docs
        run:  |
          make clean docs

      - name: Upload documentation artifacts
        uses: actions/upload-pages-artifact@v3
        with:
          path: "docs/_build/html"
          name: tsmp2_docs

  deploy:
    if: github.event_name != 'pull_request'
    needs: build
    runs-on: ubuntu-24.04
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
    permissions:
      pages: write      # to deploy to Pages
      id-token: write   # to verify the deployment originates from an appropriate source

    steps:
    - name: Deploy to GitHub Pages
      id: deployment
      uses: actions/deploy-pages@v4
      with:
        artifact_name: tsmp2_docs