Make readme more user-friendly #145
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
| # Copyright (c) 2021-2024 Antmicro <www.antmicro.com> | |
| # SPDX-License-Identifier: Apache-2.0 | |
| name: GH Pages | |
| on: [pull_request, push] | |
| jobs: | |
| docs-generation: | |
| runs-on: ubuntu-latest | |
| container: | |
| image: debian:bookworm | |
| steps: | |
| - name: Install git package | |
| run: | | |
| apt-get update -qq | |
| apt-get install -y git | |
| - uses: actions/checkout@v4 | |
| - name: Generate documentation | |
| run: | | |
| ./.github/scripts/ci.sh docs | |
| - uses: actions/upload-artifact@v3 | |
| with: | |
| name: gh-page | |
| path: docs/build/html | |
| - name: Deploy to Github Pages | |
| if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request' | |
| run: | | |
| cd docs/build/html | |
| touch .nojekyll | |
| git init | |
| cp ../../../.git/config ./.git/config | |
| git add . | |
| git config --local user.email "push@gha" | |
| git config --local user.name "GHA" | |
| git commit -am "update ${{ github.sha }}" | |
| git push -u origin +HEAD:gh-pages | |
| rm -rf .git |