docs: first take on ovh3 backups #688
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
| --- | |
| #---------------------------------------------- | |
| # Generate and upload documentation (only push to main) | |
| #---------------------------------------------- | |
| name: Generate documentation | |
| on: | |
| pull_request: | |
| # on pull request we just want to build to see nothing is broken | |
| paths: | |
| - "README.md" | |
| - "docs/**" | |
| - ".github/workflows/generate-docs.yml" | |
| - "mkdocs.yml" | |
| push: | |
| branches: | |
| - develop | |
| jobs: | |
| build-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out the repo | |
| uses: actions/checkout@v4 | |
| - name: Checks | |
| run: | | |
| make check_docs | |
| - name: Generate documentation | |
| run: | | |
| make build_docs | |
| - name: Deploy documentation to Github Pages 🚀 | |
| # we only deploy on push to main | |
| if: | | |
| github.event_name == 'push' && github.event.ref == 'refs/heads/develop' | |
| uses: JamesIves/[email protected] | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| branch: gh-pages # The branch the action should deploy to. | |
| folder: gh_pages # The folder the action should deploy. | |
| clean: true # Automatically remove deleted files from the deploy branc |