build-docs.yml

name: Documentation

on:
  push:
    branches:
      - '**'
    tags:
      - "v*.*.*"

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Set up Python
      uses: actions/setup-python@v2
      with:
        python-version: '3.10'
    - name: Setup System Dependencies
      run: |
        sudo apt-get update
        sudo apt-get install -y tzdata rsync
        sudo ln -fs /usr/share/zoneinfo/Etc/UTC /etc/localtime
        sudo dpkg-reconfigure -f noninteractive tzdata
    - name: Install Python Dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -r requirements-dev.txt
    - name: Generate Docs
      working-directory: ./Textbook
      run: |
        make html
        touch _build/html/.nojekyll
    - name: Archive Artifacts
      if: startsWith(github.ref, 'refs/tags/v')
      uses: actions/upload-artifact@v4
      with:
        name: docs
        path: Textbook/_build/html/

  deploy:
    runs-on: ubuntu-latest
    needs: build
    if: startsWith(github.ref, 'refs/tags/v')
    steps:
    - name: Download Artifacts
      uses: actions/download-artifact@v2
      with:
        name: docs
        path: ./docs
    - name: Publish Docs
      uses: JamesIves/github-pages-deploy-action@releases/v4
      with:
        token: ${{ secrets.ACCESS_TOKEN }}
        branch: gh-pages
        folder: ./docs
    - name: Create Release
      id: create_release
      uses: actions/create-release@v1
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      with:
        tag_name: ${{ github.ref }}
        release_name: Release ${{ github.ref }}
        draft: false
        prerelease: false
    - name: Upload Release Asset
      uses: actions/upload-release-asset@v1
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      with:
        upload_url: ${{ steps.create_release.outputs.upload_url }}
        asset_path: ./docs
        asset_name: docs.zip
        asset_content_type: application/zip