httomo_docs.yml

name: HTTomo docs

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

jobs:
  build-docs-publish:
    runs-on: ubuntu-latest
    defaults:
      run:
        shell: bash -el {0}
    steps:
        - name: Checkout repository code
          uses: actions/checkout@v5

        - name: Setup Python 3.12
          uses: actions/setup-python@v5
          with:
            python-version: '3.12'

        - name: httomo-docs
          uses: mamba-org/setup-micromamba@v2
          with:
            environment-name: httomo-docs
            environment-file: ./docs/source/doc-conda-requirements.yml
            post-cleanup: 'all'
            init-shell: bash

        - name: Install httomo-backends
          run: |
            pip install --no-deps httomo-backends

        - name: Generate full yaml pipelines using pipeline directives
          run: |
            python ./docs/source/scripts/execute_pipelines_build.py -o ./docs/source/pipelines_full/

        - name: Create ZIP archive for pipelines
          run: |
            zip -r pipelines_full_artifact.zip ./docs/source/pipelines_full/

        - name: Build docs
          run: sphinx-build -a -E -b html ./docs/source/ ./docs/build/

        - name: Publish docs
          if: github.ref_type == 'tag' || github.ref_name == 'main'
          run: ghp-import -n -p -f ./docs/build
          env:
            GITHUB_TOKEN: ${{ github.token }}

        - name: Upload artifact
          uses: actions/upload-artifact@v4
          with:
            name: full_pipelines-artifact
            path: pipelines_full_artifact.zip