docs: added documentation for prerequisites as well as mkdocs-weight … #16
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: ci | |
| on: | |
| push: | |
| branches: [main, master] | |
| pull_request: | |
| branches: [main, master] | |
| concurrency: | |
| group: ci-${{ github.head_ref }} | |
| cancel-in-progress: true | |
| env: | |
| PYTHONUNBUFFERED: '1' | |
| FORCE_COLOR: '1' | |
| jobs: | |
| run: | |
| name: Python ${{ matrix.python-version }} on ${{ startsWith(matrix.os, 'macos-') && 'macOS' || startsWith(matrix.os, 'windows-') && 'Windows' || 'Linux' }} | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| # os: [ubuntu-latest, windows-latest, macos-latest] | |
| # python-version: ['3.9', '3.10', '3.12'] | |
| os: [ubuntu-latest] | |
| python-version: ['3.12'] | |
| steps: | |
| - name: Checkout source code | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: ${{ github.repository }} | |
| token: ${{ github.token }} | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install Hatch | |
| run: pip install --upgrade hatch | |
| - name: Lint Python | |
| run: hatch run dev:check | |
| - name: Type check | |
| run: hatch run types:check | |
| - name: Secure Python | |
| run: hatch run dev:secure | |
| - name: Build docs | |
| run: hatch run docs:build |