Lint #42
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
| # From https://github.com/mitmproxy/pdoc/blob/main/.github/workflows/docs.yml | |
| # with minor adaptations | |
| name: gen/publish docs | |
| # 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@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.9 | |
| - name: Install Poetry | |
| uses: snok/install-poetry@v1 | |
| with: | |
| virtualenvs-create: true | |
| virtualenvs-in-project: true | |
| - name: Load cached venv if exists | |
| id: cached-poetry-dependencies | |
| uses: actions/cache@v3 | |
| with: | |
| path: .venv | |
| key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }} | |
| - name: Install dependencies if not loaded from cache | |
| if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true' | |
| run: poetry install --no-interaction --no-root | |
| - name: Install package itself | |
| run: poetry install --no-interaction | |
| - name: Generate docs | |
| run: | | |
| source .venv/bin/activate | |
| pdoc --math -o docs/ ./TPFA_ResSim | |
| - name: Upload docs | |
| uses: actions/upload-pages-artifact@v1 | |
| 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@v1 |