Add a more explicit check and an explanation comment to check.py #112
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
| # SPDX-FileCopyrightText: Daniele Nicolodi <[email protected]> | |
| # SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later | |
| name: docs | |
| on: | |
| push: | |
| pull_request: | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.11' | |
| - uses: actions/checkout@v4 | |
| - run: python -m pip install sphinx==5.3.0 furo==2022.9.29 | |
| - run: python -m sphinx -W -b html docs/ build/html/ | |
| - uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: build/html | |
| deploy: | |
| needs: build | |
| permissions: | |
| pages: write | |
| id-token: write | |
| environment: | |
| name: github-pages | |
| runs-on: ubuntu-latest | |
| if: github.ref == 'refs/heads/master' | |
| steps: | |
| - uses: actions/deploy-pages@v4 |