Skip to content

Added MkDocs documentation #13

Added MkDocs documentation

Added MkDocs documentation #13

Workflow file for this run

name: lint-and-test
on:
push:
branches: [main]
pull_request:
branches: [main]
jobs:
lint-code:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4.1.1
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Install dependencies
run: |
pip install hatch
pip install hatch-vcs
pip install hatch-fancy-pypi-readme
- name: Lint code
run: hatch run lint:style
lint-typing:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4.1.1
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Install dependencies
run: |
pip install hatch
pip install hatch-vcs
pip install hatch-fancy-pypi-readme
- name: Lint typing
run: hatch run lint:typing
test:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.10", "3.11", "3.12"]
steps:
- uses: actions/checkout@v4.1.1
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
pip install hatch
pip install hatch-vcs
pip install hatch-fancy-pypi-readme
- name: Test
run: hatch run cov-test