Bump mkdocstrings-python from 1.18.2 to 2.0.0 #68
This file contains hidden or 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: Test PR | |
| on: | |
| pull_request: | |
| env: | |
| # Please make sure this version is included in the `matrix`, as the | |
| # `matrix` section can't use `env`, so it must be entered manually | |
| DEFAULT_PYTHON_VERSION: '3.11' | |
| # It would be nice to be able to also define a DEFAULT_UBUNTU_VERSION | |
| # but sadly `env` can't be used either in `runs-on`. | |
| jobs: | |
| nox: | |
| name: Test with nox | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - name: Run nox | |
| uses: frequenz-floss/[email protected] | |
| with: | |
| python-version: "3.11" | |
| nox-session: ci_checks_max | |
| # TODO(cookiecutter): Uncomment this for projects with private dependencies | |
| # git-username: ${{ secrets.GIT_USER }} | |
| # git-password: ${{ secrets.GIT_PASS }} | |
| test-docs: | |
| name: Test documentation website generation | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - name: Setup Git | |
| uses: frequenz-floss/[email protected] | |
| # TODO(cookiecutter): Uncomment this for projects with private dependencies | |
| # with: | |
| # username: ${{ secrets.GIT_USER }} | |
| # password: ${{ secrets.GIT_PASS }} | |
| - name: Fetch sources | |
| uses: actions/checkout@v5 | |
| with: | |
| submodules: true | |
| - name: Setup Python | |
| uses: frequenz-floss/[email protected] | |
| with: | |
| python-version: ${{ env.DEFAULT_PYTHON_VERSION }} | |
| dependencies: .[dev-mkdocs] | |
| - name: Generate the documentation | |
| env: | |
| MIKE_VERSION: gh-${{ github.job }} | |
| run: | | |
| mike deploy $MIKE_VERSION | |
| mike set-default $MIKE_VERSION | |
| - name: Upload site | |
| uses: actions/upload-artifact@v5 | |
| with: | |
| name: docs-site | |
| path: site/ | |
| if-no-files-found: error |