Skip to content

Update readme

Update readme #22

Workflow file for this run

name: Documentation
on:
push:
branches: [ main]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: 3.12
- name: Install dependencies
run: |
python -m pip install --upgrade pip
- name: Install mikeio1d
run: |
pip install .[dev,docs]
- name: Build documentation
run: |
make docs
- name: Publish to GitHub Pages
uses: peaceiris/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_site/