Fix: Test with modified image path. #54
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: pdoc | |
| # build the documentation whenever there are new commits on main | |
| on: | |
| push: | |
| branches: | |
| - main | |
| # 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: ${{ vars.PYTHON_VERSION }} | |
| # ADJUST THIS: install all dependencies (including pdoc) | |
| - run: | | |
| python -m pip install --upgrade pip | |
| pip install pdoc | |
| pip install . | |
| # build documentation into docs/. | |
| - run: pdoc --favicon https://www.disy.net/favicon.ico --logo https://www.disy.net/typo3conf/ext/contentelements/Resources/Public/dist/img/logo-disy.svg --logo-link https://www.disy.net/en/products/disy-cadenza -o docs/html/ --no-show-source src/cadenzaanalytics | |
| - uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: docs/html/ | |
| # 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 |