docs.yml

name: Docs

# If a pull-request is pushed then cancel all previously running jobs related
# to that pull-request
concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
  cancel-in-progress: true 

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

env:
  PY_COLORS: 1

jobs:
  sphinx:
    runs-on: ubuntu-20.04
    steps:
      - uses: actions/checkout@v3.5.3
      - name: Set up Python
        uses: actions/setup-python@v4.7.0
        with:
          python-version: "3.11"
      - name: Install dependencies
        run: pip install tox
      - name: Build docs
        env:
          TOXENV: docs
        run: tox
      - name: Archive generated docs
        uses: actions/upload-artifact@v3.1.2
        with:
          name: html-docs
          path: build/sphinx/html/

  twine-check:
    runs-on: ubuntu-20.04
    steps:
      - uses: actions/checkout@v3.5.3
      - name: Set up Python
        uses: actions/setup-python@v4.7.0
        with:
          python-version: "3.11"
      - name: Install dependencies
        run: pip install tox twine wheel
      - name: Check twine readme rendering
        env:
          TOXENV: twine-check
        run: tox