publish-docs.yml

on: [push, pull_request]

name: "Documentation Status"

permissions:
  contents: write

jobs:
  build-and-publish:
    if: "! contains(github.event.head_commit.message, '[ci skip]')"

    timeout-minutes: 10

    runs-on: ubuntu-latest

    strategy:
      fail-fast: false

    steps:
    - uses: actions/checkout@v4

    - name: Set up Python
      uses: actions/setup-python@v4

    - name: Session information
      run: |
        python --version

    - name: Install Poetry
      uses: snok/install-poetry@v1
      with:
        virtualenvs.prefer-active-python: true

    - name: 🔩 list Poetry settings
      run: poetry config --list

    - name: 🔩 Install with Poetry
      run: poetry install --all-extras --with docs

    - name: Build documentation
      run: |
        cd docs
        poetry run bash autogen_docs.sh
        poetry run make html

    - name: Deploy to GitHub pages 🚀
      # Deploy only when master changes
      if: github.ref == 'refs/heads/master' && github.event_name == 'push'
      uses: JamesIves/github-pages-deploy-action@v4.6.0
      with:
        clean: false
        branch: gh-pages
        folder: docs/_build/html