Should fix 'gi.repository.GLib.GError:' #12
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 | |
| # build the documentation whenever there are new commits on release_v1.0.0 | |
| on: | |
| push: | |
| branches: | |
| - release_v1.0.0 | |
| # Alternative: only build for tags. | |
| # tags: | |
| # - '*' | |
| # security: restrict permissions for CI jobs. | |
| permissions: | |
| contents: read | |
| jobs: | |
| # Build the documentation and upload the static HTML files as an artifact. | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.11' | |
| # install all dependencies (including pdoc) | |
| - run: pip install pipenv | |
| - run: pipenv install | |
| # build your documentation into docs/. | |
| - run: export PDOC_ALLOW_EXEC=1 | |
| - run: pipenv run pdoc marlpde/*.py -o ./docs/ | |
| - uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: docs/ | |
| # Deploy the artifact to GitHub pages. | |
| # This is a separate job so that only actions/deploy-pages has the necessary permissions. | |
| deploy: | |
| needs: build | |
| runs-on: ubuntu-latest | |
| permissions: | |
| pages: write | |
| id-token: write | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - id: deployment | |
| uses: actions/deploy-pages@v4 |