docs: Extend documentation + deploy with mkdocs
#743
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
| # Copyright 2023 ETH Zurich and University of Bologna. | |
| # Solderpad Hardware License, Version 0.51, see LICENSE for details. | |
| # SPDX-License-Identifier: SHL-0.51 | |
| # Author: Tim Fischer <[email protected]> | |
| name: lint | |
| on: | |
| pull_request: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| ##################### | |
| # Bender up-to-date # | |
| ##################### | |
| bender-up-to-date: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check Bender up-to-date | |
| uses: pulp-platform/pulp-actions/bender-up-to-date@v2 | |
| ################ | |
| # Verible Lint # | |
| ################ | |
| verible-lint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: chipsalliance/verible-linter-action@main | |
| with: | |
| config_file: '' | |
| paths: | | |
| ./hw | |
| extra_args: "--waiver_files util/verible.waiver" | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| fail_on_error: true | |
| reviewdog_reporter: github-check | |
| ########## | |
| # PyLint # | |
| ########## | |
| pylint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.10' | |
| cache: 'pip' | |
| - name: Install dependencies and package | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install . | |
| - name: Analysing the code with pylint | |
| run: | | |
| pylint $(git ls-files '*.py') | |
| ################# | |
| # Check License # | |
| ################# | |
| lint-license: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: lint license | |
| uses: pulp-platform/pulp-actions/lint-license@v2 | |
| with: | |
| license: | | |
| Copyright (\d{4}(-\d{4})?\s)?(ETH Zurich and University of Bologna|lowRISC contributors). | |
| (Solderpad Hardware License, Version 0.51|Licensed under the Apache License, Version 2.0), see LICENSE for details. | |
| SPDX-License-Identifier: (SHL-0.51|Apache-2.0) | |
| exclude_paths: | | |
| floo_noc.core |