build-docs.yml

name: Build documentation

on:
  push:
    tags:
      - "*"

jobs:
  build_docs:
    name: Build docs 
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

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

      - name: Install Python dependencies
        run: |
          python -m pip install --upgrade pip setuptools
          DEPENDENCIES=$(python -c 'from setuptools.config.setupcfg import read_configuration as c; a = c("setup.cfg"); print(" ".join(a["options"]["install_requires"][1:]))')
          pip install ${DEPENDENCIES}
          DOCDEPENDENCIES=$(python -c 'with open("docs/requirements.txt") as a: available = list(a); print(" ".join(map(lambda x : x.strip(), filter(lambda x : not x.startswith("#"), available))))')
          pip install ${DOCDEPENDENCIES}

      - name: Build docs
        run: |
          touch src/singler/lib_singler.py
          sphinx-build --color -b html -d docs/doctrees docs docs/_build/html
          touch ./docs/_build/html/.nojekyll

      - name: GH Pages Deployment
        if: github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/')
        uses: JamesIves/github-pages-deploy-action@v4
        with:
          branch: gh-pages # The branch the action should deploy to.
          folder: ./docs/_build/html
          clean: true # Automatically remove deleted files from the deploy branch