clarify default format setting #619
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: Deploy API Doc | |
| on: | |
| workflow_dispatch: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - 'src/**' | |
| - 'favicon*' | |
| jobs: | |
| deploy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '>=3.10' | |
| - name: Install Dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install pdoc | |
| - name: Run Pdoc | |
| run: | | |
| pdoc --favicon "favicon.png" -o dist src/icepool | |
| - name: Copy Favicon | |
| run: | | |
| cp favicon.* dist/ | |
| - name: Deploy | |
| uses: JamesIves/github-pages-deploy-action@v4.4.1 | |
| with: | |
| branch: gh-pages | |
| folder: dist | |
| target-folder: apidoc/latest |