docs.yml

name: Docs

on:
  push:
    branches: [ master, develop, docs, v3.3.1 ]
    tags:
      - '*'

jobs:

  build_docs:
    runs-on: ubuntu-latest

    steps:
      - name: Setup Python
        uses: actions/setup-python@v2
        with:
          python-version: 3.9

      - name: Checkout repository
        uses: actions/checkout@v2
        with:
          path: pyconfig

      - name: Install Python dependencies
        run: |
          python -m pip install --upgrade pip
          pip install sphinx myst-parser sphinx-rtd-theme pyconfig/

      - name: Setup Envvars
        run: |
            if [[ $GITHUB_REF = "refs/tags/"* ]] ; then echo "CRYODRGN_VERSION=${GITHUB_REF/refs\/tags\//}" ; else echo "CRYODRGN_VERSION=" ; fi >> $GITHUB_ENV

      - name: Build docs
        run: |
          # Unless we add a .nojekyll to the base of the deployment folder, the underscores in foldernames
          # like _static/ etc. pose problems on GH Pages.
          cd pyconfig/docs && make html && touch _build/html/.nojekyll

      - name: Deploy
        uses: JamesIves/github-pages-deploy-action@v4
        with:
          folder: pyconfig/docs/_build/html
          branch: gh-pages