Skip to content

Rename gradient_fn to diff_method in qml.execute #54008

Rename gradient_fn to diff_method in qml.execute

Rename gradient_fn to diff_method in qml.execute #54008

Workflow file for this run

# Sphinx docs check
# -----------------
#
# There are 2 main reasons for having this dedicated Sphinx docs check in
# addition to the Read the Docs (RTD) builder:
#
# 1. This action is set up to fail on Sphinx warnings, whereas RTD's will show
# a passing sign for warnings, and only fail for errors. So this is a stricter
# check.
#
# 2. When this action detects warnings, it produces GitHub annotations on the
# Files Changed tab in the pull request. Such annotations can be convenient for
# developers/code reviewers (e.g., the same way CodeCov and CodeFactor
# annotate).
# -----------------
name: "Documentation check"
on:
pull_request:
types:
- opened
- reopened
- synchronize
- ready_for_review
permissions: write-all
jobs:
determine_runner:
if: github.event.pull_request.draft == false
name: Determine runner type to use
uses: ./.github/workflows/determine-workflow-runner.yml
with:
default_runner: ubuntu-latest
sphinx:
if: github.event.pull_request.draft == false
env:
DEPS_BRANCH: bot/stable-deps-update
needs: [determine_runner]
runs-on: ${{ needs.determine_runner.outputs.runner_group }}
steps:
- uses: actions/checkout@v4
- uses: PennyLaneAI/sphinx-action@master
with:
docs-folder: "doc/"
pre-build-command: >
apt install -y graphviz
&& pip3 install -r doc/requirements.txt
&& pip3 install .
&& pip3 install openfermionpyscf
&& pip3 install aiohttp fsspec h5py
&& pip freeze | grep -v 'file:///' > .github/stable/doc.txt.tmp
build-command: "sphinx-build -b html . _build -W --keep-going"
- name: Prepare local repo
if: github.event.pull_request.head.repo.full_name == 'PennyLaneAI/pennylane'
run: |
git fetch
git config user.name "GitHub Actions Bot"
git config user.email "<>"
if git ls-remote --exit-code origin "refs/heads/${{ env.DEPS_BRANCH }}"; then
git checkout "${{ env.DEPS_BRANCH }}"
else
git checkout master
git pull
git checkout -b "${{ env.DEPS_BRANCH }}"
fi
mv -f .github/stable/doc.txt.tmp .github/stable/doc.txt
- name: Determine if changes have been made
if: github.event.pull_request.head.repo.full_name == 'PennyLaneAI/pennylane'
id: changed
run: |
echo "has_changes=$(git status --porcelain | wc -l | awk '{print $1}')" >> $GITHUB_OUTPUT
- name: Stage changes
if: github.event.pull_request.head.repo.full_name == 'PennyLaneAI/pennylane' && steps.changed.outputs.has_changes != '0'
run: |
git add .github/stable/doc.txt
git commit -m "Update stable docs dependencies"
git push -f --set-upstream origin "${{ env.DEPS_BRANCH }}"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# Create PR to master
- name: Create pull request
if: github.event.pull_request.head.repo.full_name == 'PennyLaneAI/pennylane' && steps.changed.outputs.has_changes != '0'
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
function gh_pr_up() {
gh pr create $* || gh pr edit $*
}
gh_pr_up --title \"Update stable doc dependency files\" --body \".\"