Skip to content

disable docs builds for dependabot (#105) #17

disable docs builds for dependabot (#105)

disable docs builds for dependabot (#105) #17

Workflow file for this run

---
# used for publishing documentation on push to main or published release
name: publish docs
on:
push:
branches:
- main
release:
types:
- published
jobs:
build:
# only build and deploy docs if the actor is not dependabot
if: ${{ github.actor != 'dependabot[bot]' }}
runs-on: ubuntu-22.04
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Setup for poetry
run: |
python -m pip install poetry poetry-dynamic-versioning
- name: poetry deps
run: poetry install
- name: Build documentation
run: |
mkdir pages
touch pages/.nojekyll
cd docs
poetry run sphinx-multiversion src build
# remove any doctrees dirs which aren't needed for publishing
find ./build -type d -name '.doctrees' -exec rm -rf {} +
cp -r build/* ../pages/
- name: Add index redirector to latest docs
run: |
cp docs/redirector.html pages/index.html
- name: Deploy documentation
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: pages
folder: pages