Skip to content

Workflow file for this run

name: Generate Documentation
on:
push:
branches:
- autogenerate-docs
jobs:
generate-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.8'
- name: Install dependencies
run: |
cd docs/build
pip install -r requirements.txt
- name: Generate documentation
id: generate
run: |
cd docs/build
python build.py
git diff --quiet && DIFF=false || DIFF=true
git diff
echo $DIFF
echo "diff=$DIFF" >> $GITHUB_OUTPUT
- name: Commit and push changes
if: steps.generate.outputs.diff == 'true'
run: |
echo $GITHUB_OUTPUT
git checkout -b update-docs
git add docs/api-reference
git config --global user.name 'github-actions'
git config --global user.email '[email protected]'
git commit -m "Update documentation"
git push -u origin update-docs
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# - name: Create Pull Request
# uses: peter-evans/create-pull-request@v6
# with:
# token: ${{ secrets.GITHUB_TOKEN }}
# branch: update-docs
# title: 'Update Documentation'
# body: 'This PR updates the documentation with the latest changes.'
# labels: 'documentation'