Cleanup Examples and Tutorials (#675) #228
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Generate Documentation | |
on: | |
push: | |
branches: | |
- main | |
permissions: { } | |
jobs: | |
generate-docs: | |
permissions: | |
contents: write | |
pull-requests: write | |
# We have to use a Mac OS image because the documentation generated | |
# on Ubuntu unexpectedly rearranges the contents of quixstreams.md | |
runs-on: macos-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- run: pip install -r docs/build/requirements.txt | |
- run: python build.py | |
working-directory: ./docs/build | |
- uses: peter-evans/create-pull-request@v6 | |
with: | |
commit-message: Update documentation | |
branch: auto/update-documentation | |
delete-branch: true | |
title: 'Update Documentation' | |
body: 'This is the PR with the autogenerated documentation' | |
labels: 'documentation' |