Skip to content

Merge pull request #292 from printfinn/change-a55-101-temp #325

Merge pull request #292 from printfinn/change-a55-101-temp

Merge pull request #292 from printfinn/change-a55-101-temp #325

Workflow file for this run

# This is a workflow to compile Sphinx sources on *main* branch and update *docs-build* branch
name: Compile Sphinx source and update docs-build branch
# Controls when the workflow will run
on:
# Triggers the workflow on push events but only for the main branch
push:
branches:
- main
paths:
- docs/source/**
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Set Up Python 3.10.8
uses: actions/setup-python@v3
with:
python-version: 3.10.8
- uses: actions/checkout@master
with:
fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
- name: Update pip
run: |
pip install -U wheel
pip install -U setuptools
python -m pip install -U pip
- name: Get pip cache dir
id: pip-cache
run: |
echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
- name: Pip cache
uses: actions/cache@v3
with:
path: ${{ steps.pip-cache.outputs.dir }}
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
- name: Build and Commit
uses: iSOLveIT/sphinx-pdf-generate-action@main
with:
documentation_path: docs/source
requirements_path: docs/source/requirements.txt
config_file_path: docs/source/conf.py
target_branch: docs-build
sphinx_version: 5.3
- name: Push changes
uses: ad-m/github-push-action@master
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
branch: docs-build
force: true